mirror of
https://github.com/RGBCube/serenity
synced 2025-07-27 17:17:45 +00:00
Help+Base: Add help://man URLs for links between man pages
The URLs of the form `help://man/<section>/<page>` link to another help page inside the help application. All previous relative page links are replaced by this new form. This doesn't change any behavior but it looks much nicer :^) Note that man doesn't handle these new links, but the previous relative links didn't work either.
This commit is contained in:
parent
becf74097e
commit
98c0c5e9e6
73 changed files with 177 additions and 165 deletions
|
@ -59,5 +59,5 @@ this man page should be located at `/usr/share/man/man1/Help.md`.
|
|||
|
||||
## See Also
|
||||
|
||||
* [`man`(1)](man.md) To read these same man pages from the terminal
|
||||
* [`man`(1)](help://man/1/man) To read these same man pages from the terminal
|
||||
|
||||
|
|
|
@ -19,8 +19,8 @@ $ Inspector [pid]
|
|||
Inspector facilitates process inspection via RPC.
|
||||
|
||||
The inspected process must have previously allowed the
|
||||
[`accept`(2)](../man2/accept.md) system call with
|
||||
[`pledge`(2)](../man2/pledge.md) to allow inspection
|
||||
[`accept`(2)](help://man/2/accept) system call with
|
||||
[`pledge`(2)](help://man/2/pledge) to allow inspection
|
||||
via UNIX socket.
|
||||
|
||||
## Examples
|
||||
|
|
|
@ -31,4 +31,4 @@ $ Playground /home/anon/example.gml
|
|||
|
||||
## See also
|
||||
|
||||
* [`gml-format`(1)](../man1/gml-format.md) For automated GML formatting
|
||||
* [`gml-format`(1)](help://man/1/gml-format) For automated GML formatting
|
||||
|
|
|
@ -49,5 +49,5 @@ $ Profiler perfcore.123
|
|||
|
||||
## See also
|
||||
|
||||
* [`perfcore`(5)](../man5/perfcore.md)
|
||||
* [`perfcore`(5)](help://man/5/perfcore)
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ $ Shell [--skip-shellrc] --format command_file
|
|||
## Description
|
||||
|
||||
The `Shell` utility is a command language interpreter, which reads commands from either a command string, a specified file, or the standard input.
|
||||
The command language shall be described in [`Shell`(5)](../man5/Shell.md), _The Shell Command Language_.
|
||||
The command language shall be described in [`Shell`(5)](help://man/5/Shell), _The Shell Command Language_.
|
||||
|
||||
Any extra arguments passed into `arguments` are placed in the local variable `$ARGV` and can also be accessed through the special variable `$*`.
|
||||
|
||||
|
@ -44,4 +44,4 @@ Shell foo a b c
|
|||
|
||||
## See also
|
||||
|
||||
* [`Shell-vars`(7)](../man7/Shell-vars.md) For details on local and environment variables used by the shell
|
||||
* [`Shell-vars`(7)](help://man/7/Shell-vars) For details on local and environment variables used by the shell
|
||||
|
|
|
@ -33,7 +33,7 @@ View all stacks of pid number 10:
|
|||
$ bt 10
|
||||
```
|
||||
|
||||
Use [`watch`(1)](watch.md) to emit a backtrace of pid 124, every second:
|
||||
Use [`watch`(1)](help://man/1/watch) to emit a backtrace of pid 124, every second:
|
||||
|
||||
```sh
|
||||
$ watch -n 1 -- bt 124
|
||||
|
@ -41,8 +41,8 @@ $ watch -n 1 -- bt 124
|
|||
|
||||
## See also
|
||||
|
||||
* [`Inspector`(1)](Inspector.md)
|
||||
* [`Inspector`(1)](help://man/1/Inspector)
|
||||
|
||||
* [`Profiler`(1)](Profiler.md)
|
||||
* [`Profiler`(1)](help://man/1/Profiler)
|
||||
|
||||
* [`watch`(1)](watch.md)
|
||||
* [`watch`(1)](help://man/1/watch)
|
||||
|
|
|
@ -25,5 +25,5 @@ $ chgrp <name> <path>
|
|||
|
||||
## See also
|
||||
|
||||
* [`chmod`(1)](chmod.md)
|
||||
* [`chown`(1)](chown.md)
|
||||
* [`chmod`(1)](help://man/1/chmod)
|
||||
* [`chown`(1)](help://man/1/chown)
|
||||
|
|
|
@ -44,5 +44,5 @@ $ chmod g=r script.sh
|
|||
|
||||
## See also
|
||||
|
||||
* [`chgrp`(1)](chgrp.md)
|
||||
* [`chown`(1)](chown.md)
|
||||
* [`chgrp`(1)](help://man/1/chgrp)
|
||||
* [`chown`(1)](help://man/1/chown)
|
||||
|
|
|
@ -27,5 +27,5 @@ $ chown anon:anon file
|
|||
|
||||
## See also
|
||||
|
||||
* [`chgrp`(1)](chgrp.md)
|
||||
* [`chmod`(1)](chmod.md)
|
||||
* [`chgrp`(1)](help://man/1/chgrp)
|
||||
* [`chmod`(1)](help://man/1/chmod)
|
||||
|
|
|
@ -72,4 +72,4 @@ $ find -name \*config\*
|
|||
|
||||
## See also
|
||||
|
||||
* [`xargs`(1)](xargs.md)
|
||||
* [`xargs`(1)](help://man/1/xargs)
|
||||
|
|
|
@ -36,4 +36,4 @@ $ id -G
|
|||
|
||||
## See also
|
||||
|
||||
* [`whoami`(1)](whoami.md)
|
||||
* [`whoami`(1)](help://man/1/whoami)
|
||||
|
|
|
@ -55,4 +55,4 @@ undefined
|
|||
|
||||
## See also
|
||||
|
||||
* [`test-js`(1)](test-js.md)
|
||||
* [`test-js`(1)](help://man/1/test-js)
|
||||
|
|
|
@ -74,5 +74,5 @@ All other characters are treated normally.
|
|||
|
||||
## See Also
|
||||
|
||||
* [`more`(1)](more.md) For a simpler pager that less implements.
|
||||
* [`man`(1)](man.md) For serenity's manual pager, that uses less.
|
||||
* [`more`(1)](help://man/1/more) For a simpler pager that less implements.
|
||||
* [`man`(1)](help://man/1/man) For serenity's manual pager, that uses less.
|
||||
|
|
|
@ -53,4 +53,4 @@ this man page should be located at `/usr/share/man/man1/man.md`.
|
|||
|
||||
## See Also
|
||||
|
||||
* [`less`(1)](less.md) For the terminal pager that `man` uses by default
|
||||
* [`less`(1)](help://man/1/less) For the terminal pager that `man` uses by default
|
||||
|
|
|
@ -28,4 +28,4 @@ $ mkdir -m a=rx /tmp/foo/bar
|
|||
|
||||
## See also
|
||||
|
||||
* [`mkdir`(2)](../man2/mkdir.md)
|
||||
* [`mkdir`(2)](help://man/2/mkdir)
|
||||
|
|
|
@ -11,7 +11,7 @@ $ more
|
|||
## Description
|
||||
|
||||
`more` reads data from standard input and prints it to standard output, screen by screen.
|
||||
`more` is a symlink for [`less`(1)](less.md), which has a more emulation mode.
|
||||
`more` is a symlink for [`less`(1)](help://man/1/less), which has a more emulation mode.
|
||||
|
||||
## Examples
|
||||
|
||||
|
@ -23,4 +23,4 @@ $ more
|
|||
|
||||
## See Also
|
||||
|
||||
* [`less`(1)](less.md) For the more advanced terminal pager that implements more.
|
||||
* [`less`(1)](help://man/1/less) For the more advanced terminal pager that implements more.
|
||||
|
|
|
@ -24,4 +24,4 @@ $ pmap $$
|
|||
|
||||
## See also
|
||||
|
||||
* [`ps`(1)](../man1/ps.md)
|
||||
* [`ps`(1)](help://man/1/ps)
|
||||
|
|
|
@ -50,4 +50,4 @@ $ printf '%d%d%d' 1 2 3 4 x
|
|||
|
||||
## See also
|
||||
|
||||
* [`echo`(1)](../man1/echo.md)
|
||||
* [`echo`(1)](help://man/1/echo)
|
||||
|
|
|
@ -24,4 +24,4 @@ $ readlink /proc/self/cwd
|
|||
|
||||
## See also
|
||||
|
||||
* [`readlink`(2)](../man2/readlink.md)
|
||||
* [`readlink`(2)](help://man/2/readlink)
|
||||
|
|
|
@ -39,4 +39,4 @@ $ tar -x -f archive.tar
|
|||
|
||||
## See also
|
||||
|
||||
* [`unzip`(1)](unzip.md)
|
||||
* [`unzip`(1)](help://man/1/unzip)
|
||||
|
|
|
@ -43,4 +43,4 @@ describe("Examples from Gary Bernhardt's 'Wat' talk", () => {
|
|||
|
||||
## See also
|
||||
|
||||
* [`js`(1)](js.md)
|
||||
* [`js`(1)](help://man/1/js)
|
||||
|
|
|
@ -93,4 +93,4 @@ $ /bin/test \( 10 -gt 20 \) -o \( ! 10 -ne 10 \) && echo "magic numbers!"
|
|||
|
||||
## See Also
|
||||
|
||||
* [`find`(1)](find.md)
|
||||
* [`find`(1)](help://man/1/find)
|
||||
|
|
|
@ -30,4 +30,4 @@ Serenity i686
|
|||
|
||||
## See also
|
||||
|
||||
* [`uname`(2)](../man2/uname.md)
|
||||
* [`uname`(2)](help://man/2/uname)
|
||||
|
|
|
@ -23,4 +23,4 @@ root
|
|||
|
||||
## See also
|
||||
|
||||
* [`id`(1)](id.md)
|
||||
* [`id`(1)](help://man/1/id)
|
||||
|
|
|
@ -48,4 +48,4 @@ $ xargs -a stuff --null -s 1024
|
|||
|
||||
## See also
|
||||
|
||||
* [`find`(1)](find.md)
|
||||
* [`find`(1)](help://man/1/find)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue