RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 05:27:46 +00:00
Code Issues Activity Actions

Help+man.md: Add man sections

Browse source 
Also correct minor formatting mistake in TelnetServer.md.
This commit is contained in:
Larkin Nickle 2019-09-29 16:25:29 -04:00 • committed by Andreas Kling
parent e7c2467231
commit 3fb88cb76d
3 changed files with 19 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Applications/Help/ManualModel.cpp
View file

@ -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()

8
Base/usr/share/man/man1/man.md
View file

@ -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

9
Base/usr/share/man/man8/TelnetServer.md
View file

@ -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"
``` ```