Base: Expand "See Also" sections of many manpages

This commit focuses on the CLI utilities.
2024-07-23 11:04:40 +00:00 · 2023-07-06 00:38:49 +02:00 · 2023-07-06 00:38:49 +02:00 · afaea38be2
parent f544132fe8
commit afaea38be2
56 changed files with 162 additions and 25 deletions
--- a/Base/root/generate_manpages.sh
+++ b/Base/root/generate_manpages.sh
@ -25,14 +25,8 @@ for i in ( \
            (config 1) \
            (fortune 1) \
            (grep 1) \
-            (gunzip 1) \
-            (gzip 1) \
-            (ifconfig 1) \
-            (lsof 1) \
            (nc 1) \
-            (netstat 1) \
            (nl 1) \
-            (ntpquery 1) \
            (passwd 1) \
            (readelf 1) \
            (shot 1) \
@ -40,9 +34,7 @@ for i in ( \
            (strace 1) \
            (tr 1) \
            (traceroute 1) \
-            (tree 1) \
            (truncate 1) \
-            (utmpupdate 1) \
        ) {
    filename="generated_manpages/man$i[1]/$i[0].md"
    mkdir -p "generated_manpages/man$i[1]"
--- a/Base/usr/share/man/man1/Applications/Profiler.md
+++ b/Base/usr/share/man/man1/Applications/Profiler.md
@ -50,4 +50,4 @@ $ Profiler perfcore.123
 ## See also

 * [`perfcore`(5)](help://man/5/perfcore)
-
+* [`profile`(1)](help://man/1/profile)
--- a/Base/usr/share/man/man1/cat.md
+++ b/Base/usr/share/man/man1/cat.md
@ -51,3 +51,8 @@ cat test.txt test2.txt
 123
 456
 ```
+
+## See Also
+* [`head`(1)](help://man/1/head)
+* [`tail`(1)](help://man/1/tail)
+* [`cut`(1)](help://man/1/cut)
--- a/Base/usr/share/man/man1/cmp.md
+++ b/Base/usr/share/man/man1/cmp.md
@ -27,3 +27,6 @@ Compare two files and report the location of any differences. By default, execut
 * 0 - Files are identical.
 * 1 - Files are different.
 * 2 - An error occurred.
+
+## See also
+* [`comm`(1)](help://man/1/comm)
--- a/Base/usr/share/man/man1/comm.md
+++ b/Base/usr/share/man/man1/comm.md
@ -48,3 +48,6 @@ $ sort < file1 | comm -12c - file2_sorted | less
 # and print a summary
 $ comm -123it file1_sorted file2_sorted
 ```
+
+## See also
+* [`cmp`(1)](help://man/1/cmp)
--- a/Base/usr/share/man/man1/copy.md
+++ b/Base/usr/share/man/man1/copy.md
@ -26,3 +26,6 @@ $ cat image.png | copy -t image/png
 # Place text 'foo' in clipboard
 $ copy foo
 ```
+
+## See also
+* [`clipboard`(5)](help://man/5/clipboard)
--- a/Base/usr/share/man/man1/cp.md
+++ b/Base/usr/share/man/man1/cp.md
@ -34,3 +34,6 @@ $ cp -R tests tests-backup
 # Copy test file into existing root
 $ cp test root
 ```
+
+## See also
+* [`mv`(1)](help://man/1/mv)
--- a/Base/usr/share/man/man1/cut.md
+++ b/Base/usr/share/man/man1/cut.md
@ -47,3 +47,7 @@ $ echo "serenity is cool" | cut -b 5
 n

 ```
+
+## See Also
+* [`head`(1)](help://man/1/head)
+* [`cat`(1)](help://man/1/cat)
--- a/Base/usr/share/man/man1/date.md
+++ b/Base/usr/share/man/man1/date.md
@ -37,3 +37,6 @@ $ date +%Y-%m-%d
 # Set date to 1610017485 (UNIX time)
 $ date -s 1610017485
 ```
+
+## See Also
+* [`ntpquery`(1)](help://man/1/ntpquery)
--- a/Base/usr/share/man/man1/expr.md
+++ b/Base/usr/share/man/man1/expr.md
@ -70,4 +70,5 @@ $ expr substr foobar 1 3  # foo
 ```

 ## See also
-
+* [`test`(1)](help://man/1/test)
+* [`js`(1)](help://man/1/js) for evaluating more complex expressions
--- a/Base/usr/share/man/man1/gml-format.md
+++ b/Base/usr/share/man/man1/gml-format.md
@ -21,3 +21,6 @@ $ gml-format [--inplace] [path...]
 ```sh
 $ gml-format -i /home/anon/example.gml
 ```
+
+## See Also
+* [`GML`(5)](help://man/5/GML)
--- a/Base/usr/share/man/man1/groups.md
+++ b/Base/usr/share/man/man1/groups.md
@ -29,3 +29,6 @@ $ groups nona
 $ groups nona anon root
 ```

+## See Also
+* [`groupdel`(8)](help://man/8/groupdel)
+* [`groupadd`(8)](help://man/8/groupadd)
--- a/Base/usr/share/man/man1/gunzip.md
+++ b/Base/usr/share/man/man1/gunzip.md
@ -17,4 +17,6 @@ $ gunzip [--keep] [--stdout] <FILE...>

 * `FILE`: File to decompress

-<!-- Auto-generated through ArgsParser -->
+## See also
+* [`gzip`(1)](help://man/1/gzip)
+* [`tar`(1)](help://man/1/tar)
--- a/Base/usr/share/man/man1/gzip.md
+++ b/Base/usr/share/man/man1/gzip.md
@ -18,4 +18,6 @@ $ gzip [--keep] [--stdout] [--decompress] <FILES...>

 * `FILES`: Files

-<!-- Auto-generated through ArgsParser -->
+## See also
+* [`gunzip`(1)](help://man/1/gunzip)
+* [`tar`(1)](help://man/1/tar)
--- a/Base/usr/share/man/man1/head.md
+++ b/Base/usr/share/man/man1/head.md
@ -39,3 +39,6 @@ Graphical Unix-like operating system for x86 computers.

 ```

+## See also
+* [`tail`(1)](help://man/1/tail)
+* [`cat`(1)](help://man/1/cat)
--- a/Base/usr/share/man/man1/id.md
+++ b/Base/usr/share/man/man1/id.md
@ -37,3 +37,5 @@ $ id -G
 ## See also

 * [`whoami`(1)](help://man/1/whoami)
+* [`groups`(1)](help://man/1/groups)
+* [`usermod`(8)](help://man/8/usermod)
--- a/Base/usr/share/man/man1/ifconfig.md
+++ b/Base/usr/share/man/man1/ifconfig.md
@ -19,3 +19,7 @@ Display or modify the configuration of each network interface.
 * `-m mask`, `--mask mask`: Set the network mask of the selected network

 <!-- Auto-generated through ArgsParser -->
+
+## See Also
+* [`Network`(5)](help://man/5/Network)
+* [`netstat`(1)](help://man/1/netstat)
--- a/Base/usr/share/man/man1/jail-attach.md
+++ b/Base/usr/share/man/man1/jail-attach.md
@ -30,3 +30,7 @@ $ jail-attach -i 0 ps -ef
 # Attach the command "/bin/Shell" to a new jail with the name "test jail"
 $ jail-attach -n "test jail" /bin/Shell
 ```
+
+## See also
+* [`jail-create`(1)](help://man/1/jail-create)
+* [`lsjails`(1)](help://man/1/lsjails)
--- a/Base/usr/share/man/man1/jail-create.md
+++ b/Base/usr/share/man/man1/jail-create.md
@ -25,3 +25,7 @@ $ jail-create test-jail
 # Create jail with the name "test-jail", with PID isolation
 $ jail-create -p test-jail
 ```
+
+## See also
+* [`jail-attach`(1)](help://man/1/jail-attach)
+* [`lsjails`(1)](help://man/1/lsjails)
--- a/Base/usr/share/man/man1/ls.md
+++ b/Base/usr/share/man/man1/ls.md
@ -54,3 +54,5 @@ $ ls /etc
 $ ls -la /etc
 ```

+## See also
+* [`tree`(1)](help://man/1/tree) to show the contents of the directory and subdirectories in a tree visualization
--- a/Base/usr/share/man/man1/lsjails.md
+++ b/Base/usr/share/man/man1/lsjails.md
@ -20,3 +20,7 @@ Please note that if the current process is in jail, it will not see any jail.
 Index   Name
 2       test-jail
 ```
+
+## See also
+* [`jail-create`(1)](help://man/1/jail-create)
+* [`jail-attach`(1)](help://man/1/jail-attach)
--- a/Base/usr/share/man/man1/lsof.md
+++ b/Base/usr/share/man/man1/lsof.md
@ -23,4 +23,6 @@ List open files of a processes. This can mean actual files in the file system, s

 * `filename`: Filename

-<!-- Auto-generated through ArgsParser -->
+## See Also
+* [`pmap`(1)](help://man/1/pmap)
+* [`ps`(1)](help://man/1/ps)
--- a/Base/usr/share/man/man1/md.md
+++ b/Base/usr/share/man/man1/md.md
@ -26,3 +26,6 @@ Here's how you can render this man page into HTML:
 ```sh
 $ md --html /usr/share/man/man1/md.md
 ```
+
+## See Also
+* [`man`(1)](help://man/1/man) to more easily read manpages
--- a/Base/usr/share/man/man1/mktemp.md
+++ b/Base/usr/share/man/man1/mktemp.md
@ -32,3 +32,7 @@ $ mktemp -u
 # Create a temporary directory with a custom template
 $ mktemp -d serenity.XXXXX
 ```
+
+## See also
+* [`mkdir`(1)](help://man/1/mkdir) to create a regular directory
+* [`touch`(1)](help://man/1/touch) to create a regular file
--- a/Base/usr/share/man/man1/mv.md
+++ b/Base/usr/share/man/man1/mv.md
@ -26,3 +26,6 @@ $ mv bin /usr
 $ mv *.cpp /usr/src
 $ mv old.txt new.txt
 ```
+
+## See also
+* [`cp`(1)](help://man/1/cp)
--- a/Base/usr/share/man/man1/netstat.md
+++ b/Base/usr/share/man/man1/netstat.md
@ -23,4 +23,5 @@ Display network connections
 * `-W`, `--wide`: Do not truncate IP addresses by printing out the whole symbolic host
 * `-e`, `--extend`: Display more information

-<!-- Auto-generated through ArgsParser -->
+## See Also
+* [`ifconfig`(1)](help://man/1/ifconfig)
--- a/Base/usr/share/man/man1/ntpquery.md
+++ b/Base/usr/share/man/man1/ntpquery.md
@ -18,4 +18,5 @@ $ ntpquery [--adjust] [--set] [--verbose] [host]

 * `host`: NTP server

-<!-- Auto-generated through ArgsParser -->
+## See Also
+* [`date`(1)](help://man/1/date)
--- a/Base/usr/share/man/man1/pgrep.md
+++ b/Base/usr/share/man/man1/pgrep.md
@ -24,3 +24,7 @@ $ pgrep [--count] [-d delimiter] [--ignore-case] [--list-name] [--newest] [--old
 ## Arguments

 * `process-name`: Process name to search for
+
+## See also
+* [`pidof`(1)](help://man/1/pidof)
+* [`ps`(1)](help://man/1/ps)
--- a/Base/usr/share/man/man1/pidof.md
+++ b/Base/usr/share/man/man1/pidof.md
@ -17,3 +17,7 @@ $ pidof [-s] [-o pid] [-S separator] <process-name>
 ## Arguments

 * `process-name`: Process name to search for
+
+## See also
+* [`pgrep`(1)](help://man/1/pgrep)
+* [`ps`(1)](help://man/1/ps)
--- a/Base/usr/share/man/man1/pkill.md
+++ b/Base/usr/share/man/man1/pkill.md
@ -23,3 +23,6 @@ $ pkill [--count] [--ignore-case] [--echo] [--newest] [--oldest] [--older second
 ## Arguments

 * `process-name`: Process name to search for
+
+## See Also
+* [`ps`(1)](help://man/1/ps)
--- a/Base/usr/share/man/man1/pmap.md
+++ b/Base/usr/share/man/man1/pmap.md
@ -23,5 +23,5 @@ $ pmap $$
 ```

 ## See also
-
+* [`lsof`(1)](help://man/1/lsof)
 * [`ps`(1)](help://man/1/ps)
--- a/Base/usr/share/man/man1/profile.md
+++ b/Base/usr/share/man/man1/profile.md
@ -42,3 +42,4 @@ $ profile -t syscall -- echo "Hello friends!"
 ## See also

 * [`Profiler`(1)](help://man/1/Applications/Profiler) GUI for viewing profiling data produced by `profile`.
+* [`strace`(1)](help://man/1/strace)
--- a/Base/usr/share/man/man1/ps.md
+++ b/Base/usr/share/man/man1/ps.md
@ -27,3 +27,7 @@ For each process, print its PID (process ID), to which TTY it belongs, and invok
 ```sh
 $ ps -ef
 ```
+
+## See Also
+* [`pmap`(1)](help://man/1/pmap)
+* [`lsof`(1)](help://man/1/lsof)
--- a/Base/usr/share/man/man1/rm.md
+++ b/Base/usr/share/man/man1/rm.md
@ -30,3 +30,6 @@ $ rm README.md
 # Remove Tests directory
 $ rm -r Tests
 ```
+
+## See also
+* [`rmdir`(1)](help://man/1/rmdir) to just delete empty directories
--- a/Base/usr/share/man/man1/rmdir.md
+++ b/Base/usr/share/man/man1/rmdir.md
@ -40,3 +40,7 @@ example: No such file or directory
 # Removes foo/bar/baz/, foo/bar/ and foo/
 $ rmdir -p foo/bar/baz/
 ```
+
+## See also
+* [`mkdir`(1)](help://man/1/mkdir)
+* [`rm`(1)](help://man/1/rm)
--- a/Base/usr/share/man/man1/strace.md
+++ b/Base/usr/share/man/man1/strace.md
@ -24,3 +24,7 @@ Trace all syscalls and their result.
 * `argument`: Arguments to exec

 <!-- Auto-generated through ArgsParser -->
+
+## See Also
+* [`profile`(1)](help://man/1/profile)
+* [`Profiler`(1)](help://man/1/Applications/Profiler)
--- a/Base/usr/share/man/man1/su.md
+++ b/Base/usr/share/man/man1/su.md
@ -37,3 +37,6 @@ Switch to another user
 ```sh
 $ su nona
 ```
+
+## See also
+* [`pls`(8)](help://man/8/pls)
--- a/Base/usr/share/man/man1/test.md
+++ b/Base/usr/share/man/man1/test.md
@ -97,5 +97,5 @@ $ /bin/test \( 10 -gt 20 \) -o \( ! 10 -ne 10 \) && echo "magic numbers!"
 ```

 ## See Also
-
+* [`expr`(1)](help://man/1/expr)
 * [`find`(1)](help://man/1/find)
--- a/Base/usr/share/man/man1/touch.md
+++ b/Base/usr/share/man/man1/touch.md
@ -51,6 +51,6 @@ $ touch -r anotherfile thatfile
 ```

 ## See also
-
+* [`mktemp`(1)](help://man/1/mktemp) to create a temporary file
 * [`futimens`(2)](help://man/3/futimens)
 * [`utimensat`(2)](help://man/3/utimensat)
--- a/Base/usr/share/man/man1/tree.md
+++ b/Base/usr/share/man/man1/tree.md
@ -18,4 +18,5 @@ $ tree [--all] [--only-directories] [--maximum-depth level] [directories...]

 * `directories`: Directories to print

-<!-- Auto-generated through ArgsParser -->
+## See also
+* [`ls`(1)](help://man/1/ls) to show just the contents of one directory
--- a/Base/usr/share/man/man1/unveil.md
+++ b/Base/usr/share/man/man1/unveil.md
@ -27,3 +27,8 @@ Run `ps -ef` with restricted access to certain paths:
 ```sh
 $ unveil --path=r,/etc/timezone --path=r,/usr/lib --path=r,/sys/ --path=r,/etc/passwd --path=r,/etc/group ps -ef
 ```
+
+## See also
+* [`pledge`(2)](help://man/2/pledge)
+* [`unveil`(2)](help://man/2/unveil)
+* [`Mitigations`(7)](help://man/7/Mitigations)
--- a/Base/usr/share/man/man1/unzip.md
+++ b/Base/usr/share/man/man1/unzip.md
@ -37,3 +37,8 @@ $ unzip archive.zip "*.tx_"
 Archive: archive.unzip
 extracting: file1.txt
 ```
+
+## See also
+* [`zip`(1)](help://man/1/zip)
+* [`gunzip`(1)](help://man/1/gunzip)
+* [`tar`(1)](help://man/1/tar)
--- a/Base/usr/share/man/man1/utmpupdate.md
+++ b/Base/usr/share/man/man1/utmpupdate.md
@ -19,4 +19,5 @@ $ utmpupdate [--create] [--delete] [--PID PID] [--from From] <tty>

 * `tty`: TTY name

-<!-- Auto-generated through ArgsParser -->
+## See also
+* [`w`(1)](help://man/1/w)
--- a/Base/usr/share/man/man1/w.md
+++ b/Base/usr/share/man/man1/w.md
@ -15,3 +15,8 @@ $ w [--no-header] [user]
 ## Arguments

 * `user`: Only show information about the specified user
+
+## See also
+* [`whoami`(1)](help://man/1/whoami)
+* [`utmpupdate`(1)](help://man/1/utmpupdate)
+* [`usermod`(8)](help://man/8/usermod)
--- a/Base/usr/share/man/man1/yes.md
+++ b/Base/usr/share/man/man1/yes.md
@ -39,3 +39,6 @@ t
 t
 t^C
 ```
+
+## See also
+* [`cat`(1)](help://man/1/cat)
--- a/Base/usr/share/man/man1/zip.md
+++ b/Base/usr/share/man/man1/zip.md
@ -28,3 +28,8 @@ Archive: archive.zip
  adding: file1.txt
  adding: file2.png
 ```
+
+## See also
+* [`unzip`(1)](help://man/1/unzip)
+* [`gzip`(1)](help://man/1/gzip)
+* [`tar`(1)](help://man/1/tar)
--- a/Base/usr/share/man/man2/unveil.md
+++ b/Base/usr/share/man/man2/unveil.md
@ -96,5 +96,6 @@ unveil(nullptr, nullptr);

 ## See also

+* [`unveil`(1)](help://man/1/unveil)
 * [`pledge`(2)](help://man/2/pledge)
 * [`Mitigations`(7)](help://man/7/Mitigations)
--- a/Base/usr/share/man/man5/GML.md
+++ b/Base/usr/share/man/man5/GML.md
@ -50,6 +50,7 @@ Or right clicking on a folder in the TreeView and using
        -   [IconView](help://man/5/GML/Widget/IconView)
        -   [ImageWidget](help://man/5/GML/Widget/ImageWidget)
        -   [Label](help://man/5/GML/Widget/Label)
+        -   [LinkLabel](help://man/5/GML/Widget/LinkLabel)
        -   [ListView](help://man/5/GML/Widget/ListView)
        -   [MultiView](help://man/5/GML/Widget/MultiView)
        -   [OpacitySlider](help://man/5/GML/Widget/OpacitySlider)
--- a/Base/usr/share/man/man5/Network.md
+++ b/Base/usr/share/man/man5/Network.md
@ -39,3 +39,6 @@ DHCP=true
 [ep1s1]
 Enabled=false
 ```
+
+## See Also
+* [`ifconfig`(1)](help://man/1/ifconfig)
--- a/Base/usr/share/man/man8/groupadd.md
+++ b/Base/usr/share/man/man8/groupadd.md
@ -30,3 +30,7 @@ This program must be run as root.
 # groupadd maintainers
 ```

+## See Also
+* [`useradd`(8)](help://man/8/useradd)
+* [`groupdel`(8)](help://man/8/groupdel)
+* [`groups`(1)](help://man/1/groups)
--- a/Base/usr/share/man/man8/groupdel.md
+++ b/Base/usr/share/man/man8/groupdel.md
@ -40,6 +40,6 @@ You should manually check all users to ensure that no user remain in this group.
 ```

 ## See Also
-
-* [`useradd`(8)](help://man/8/groupadd)
-
+* [`userdel`(8)](help://man/8/userdel)
+* [`groupadd`(8)](help://man/8/groupadd)
+* [`groups`(1)](help://man/1/groups)
--- a/Base/usr/share/man/man8/mount.md
+++ b/Base/usr/share/man/man8/mount.md
@ -49,3 +49,4 @@ Additionally, the name `defaults` is accepted and ignored.
 ## See also

 * [`mount`(2)](help://man/2/mount)
+* [`umount`(8)](help://man/8/umount)
--- a/Base/usr/share/man/man8/pls.md
+++ b/Base/usr/share/man/man8/pls.md
@ -35,3 +35,6 @@ Password:
 root
 #
 ```
+
+## See also
+* [`su`(1)](help://man/1/su)
--- a/Base/usr/share/man/man8/useradd.md
+++ b/Base/usr/share/man/man8/useradd.md
@ -49,3 +49,6 @@ This program must be run as root.
 # useradd --create-home supercomputer7
 ```

+## See also
+* [`userdel`(8)](help://man/8/userdel)
+* [`usermod`(8)](help://man/8/usermod)
--- a/Base/usr/share/man/man8/userdel.md
+++ b/Base/usr/share/man/man8/userdel.md
@ -39,5 +39,5 @@ This program must be run as root.
 ```

 ## See Also
-
+* [`usermod`(8)](help://man/8/usermod)
 * [`useradd`(8)](help://man/8/useradd)
--- a/Base/usr/share/man/man8/usermod.md
+++ b/Base/usr/share/man/man8/usermod.md
@ -33,4 +33,6 @@ This program must be run as root.

 * `username`: Username of the account to modify

-<!-- Auto-generated through ArgsParser -->
+## See also
+* [`userdel`(8)](help://man/8/userdel)
+* [`useradd`(8)](help://man/8/useradd)