mirror of
https://github.com/RGBCube/serenity
synced 2025-07-25 21:37:35 +00:00
Help+man.md: Add man sections
Also correct minor formatting mistake in TelnetServer.md.
This commit is contained in:
parent
e7c2467231
commit
3fb88cb76d
3 changed files with 19 additions and 6 deletions
|
@ -6,7 +6,13 @@
|
||||||
|
|
||||||
static ManualSectionNode s_sections[] = {
|
static ManualSectionNode s_sections[] = {
|
||||||
{ "1", "Command-line programs" },
|
{ "1", "Command-line programs" },
|
||||||
{ "2", "System calls" }
|
{ "2", "System calls" },
|
||||||
|
{ "3", "Libraries" },
|
||||||
|
{ "4", "Special files" },
|
||||||
|
{ "5", "File formats" },
|
||||||
|
{ "6", "Games" },
|
||||||
|
{ "7", "Miscellanea" },
|
||||||
|
{ "8", "Sysadmin tools" }
|
||||||
};
|
};
|
||||||
|
|
||||||
ManualModel::ManualModel()
|
ManualModel::ManualModel()
|
||||||
|
|
|
@ -21,8 +21,14 @@ The Serenity manual is split into the following *sections*, or *chapters*:
|
||||||
|
|
||||||
1. Command-line programs
|
1. Command-line programs
|
||||||
2. System calls
|
2. System calls
|
||||||
|
3. Libraries
|
||||||
|
4. Special files
|
||||||
|
5. File formats
|
||||||
|
6. Games
|
||||||
|
7. Miscellanea
|
||||||
|
8. Sysadmin tools
|
||||||
|
|
||||||
More sections will be added in the future.
|
Sections are subject to change in the future.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -5,20 +5,21 @@ TelnetServer - Serenity telnet server
|
||||||
## Synopsis
|
## Synopsis
|
||||||
|
|
||||||
```**sh
|
```**sh
|
||||||
$ TelnetServer [options]
|
# TelnetServer [options]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
`TelnetServer` is a basic telnet server for Serenity. By default, it
|
TelnetServer is a basic telnet server for Serenity. By default, it
|
||||||
runs on port 23 and provides a shell upon connection.
|
runs on port 23 and provides a shell upon connection.
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
* `-p`: Choose different port for TelnetServer to attach to.
|
* `-p`: Choose different port for TelnetServer to attach to.
|
||||||
* `-c`: Choose different program for TelnetServer to run on connection.
|
* `-c`: Choose different program for TelnetServer to run on connection. Arguments can be passed to the program.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ TelnetServer -p 24 -c /usr/bin/nyancat
|
# TelnetServer -p 24 -c "/usr/bin/nyancat -f 60"
|
||||||
```
|
```
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue