style-guide,pages/*: remove extra text from See Also (#20367)

2026-08-28 11:25:16 +08:00 · 2025-12-30 12:11:45 +01:00
parent a718d213fe
commit 9467f3b875
63 changed files with 64 additions and 70 deletions
@@ -319,12 +319,6 @@ For example, Use <https://learn.microsoft.com/windows-server/administration/wind
 > See also: `command1`, `command2`, `command3`.
 ```

- Optionally, you can add a short description beside the referenced pages:
-
-```md
-> See also: `date` for Unix information, `uname` for system information and `umount` for unmounting partitions.
-```
-
 - When a command features subcommands, those pages can be referenced with the following line. Note that only the subcommand is named:

 ```md
@@ -1,7 +1,7 @@
 # ack

 > A search tool like `grep`, optimized for developers.
-> See also: `rg`, which is much faster.
+> See also: `rg`.
 > More information: <https://beyondgrep.com/documentation/>.

 - Search for files containing a string or `regex` in the current directory recursively:
@@ -1,7 +1,7 @@
 # age-keygen

 > Generate `age` key pairs.
-> See also: `age` for encrypting/decrypting files.
+> See also: `age`.
 > More information: <https://manned.org/age-keygen>.

 - Generate a key pair, save it to an unencrypted file, and print the public key to `stdout`:
@@ -1,7 +1,7 @@
 # age

 > A simple, modern, and secure file encryption tool.
-> See also: `age-keygen` for generating key pairs.
+> See also: `age-keygen`.
 > More information: <https://github.com/FiloSottile/age#usage>.

 - Generate an encrypted file that can be decrypted with a passphrase:
@@ -1,7 +1,7 @@
 # bash

 > Bourne-Again SHell, an `sh`-compatible command-line interpreter.
-> See also: `zsh`, `!` (history expansion).
+> See also: `zsh`, `!`.
 > More information: <https://www.gnu.org/software/bash/manual/bash.html#Invoking-Bash>.

 - Start an interactive shell session:
@@ -1,7 +1,7 @@
 # conda activate

 > Activate a conda environment.
-> See also: `conda deactivate` to deactivate a conda environment.
+> See also: `conda deactivate`.
 > More information: <https://docs.conda.io/projects/conda/en/stable/dev-guide/deep-dives/activation.html>.

 - Activate an existing environment named `myenv`:
@@ -1,7 +1,7 @@
 # disown

 > Allow sub-processes to live beyond the shell that they are attached to.
-> See also: `jobs` for finding job numbers.
+> See also: `jobs`.
 > More information: <https://www.gnu.org/software/bash/manual/bash.html#index-disown>.

 - Disown the current job:
@@ -1,7 +1,7 @@
 # dmypy

 > Type check Python code, running `mypy` as a daemon for better speed.
-> See also: `mypy` for more options to use with check and run.
+> See also: `mypy`.
 > More information: <https://mypy.readthedocs.io/en/stable/mypy_daemon.html>.

 - Type check a file, and start the daemon if it is not running:
@@ -1,7 +1,7 @@
 # encfs

 > Mount or create encrypted virtual filesystems.
-> See also: `fusermount` which can unmount filesystems mounted by this command.
+> See also: `fusermount`.
 > More information: <https://manned.org/encfs>.

 - Initialize or mount an encrypted filesystem:
@@ -1,7 +1,7 @@
 # gcloud help

 > Display help and reference information for `gcloud`.
-> See also: `gcloud topic` for supplementary help topics not directly associated with individual commands.
+> See also: `gcloud topic`.
 > More information: <https://docs.cloud.google.com/sdk/gcloud/reference/help>.

 - Search the `gcloud` CLI reference documents for specific terms:
@@ -1,7 +1,7 @@
 # gcloud topic

 > Display supplementary help for topics not directly associated with individual commands.
-> See also: `gcloud help` for general help.
+> See also: `gcloud help`.
 > More information: <https://docs.cloud.google.com/sdk/gcloud/reference/topic>.

 - View supplementary help material for non-command topics like accessibility, filtering, and formatting:
@@ -1,7 +1,7 @@
 # git am

 > Apply patch files and create a commit. Useful when receiving commits via email.
-> See also: `git format-patch` which can generate patch files.
+> See also: `git format-patch`.
 > More information: <https://git-scm.com/docs/git-am>.

 - Apply and commit changes following a local patch file:
@@ -1,7 +1,7 @@
 # git apply

 > Apply a patch to files and/or to the index without creating a commit.
-> See also: `git am` which applies a patch and also creates a commit.
+> See also: `git am`.
 > More information: <https://git-scm.com/docs/git-apply>.

 - Print messages about the patched files:
@@ -1,8 +1,8 @@
 # git fsck

 > Verify the validity and connectivity of nodes in a Git repository index.
-> Does not make any modifications.
-> See also: `git gc` for cleaning up dangling blobs.
+> Note: Does not make any modifications.
+> See also: `git gc`.
 > More information: <https://git-scm.com/docs/git-fsck>.

 - Check the current repository:
@@ -1,7 +1,7 @@
 # hledger

 > A robust, friendly plain text accounting app.
-> See also: `hledger-ui` for TUI, `hledger-web` for web interface.
+> See also: `hledger-ui`, `hledger-web`.
 > More information: <https://hledger.org/hledger.html>.

 - Record new transactions interactively, saving to the default journal file:
@@ -1,7 +1,7 @@
 # httpie

 > Management interface for HTTPie.
-> See also: `http`, the tool itself.
+> See also: `http`.
 > More information: <https://httpie.io/docs/cli/plugin-manager>.

 - Check updates for `http`:
@@ -1,7 +1,7 @@
 # kube-fzf

 > Shell commands for command-line fuzzy searching of Kubernetes Pods.
-> See also: `kubectl` for related commands.
+> See also: `kubectl`.
 > More information: <https://github.com/thecasualcoder/kube-fzf>.

 - Get pod details (from current namespace):
@@ -1,7 +1,7 @@
 # lambo

 > A super-powered `laravel new` for Laravel and Valet.
-> See also: `lambo new` for additional command flags.
+> See also: `lambo new`.
 > More information: <https://github.com/tighten/lambo#usage>.

 - Create a new Laravel application:
@@ -1,7 +1,7 @@
 # mosquitto_passwd

 > Manage password files for mosquitto.
-> See also: `mosquitto`, the MQTT server that this manages.
+> See also: `mosquitto`.
 > More information: <https://mosquitto.org/man/mosquitto_passwd-1.html>.

 - Add a new user to a password file (will prompt to enter the password):
@@ -1,7 +1,7 @@
 # mysqldump

 > Backups MySQL databases.
-> See also: `mysql` for restoring databases.
+> See also: `mysql`.
 > More information: <https://dev.mysql.com/doc/refman/en/mysqldump.html>.

 - Create a backup (user will be prompted for a password):
@@ -1,7 +1,7 @@
 # netperf

 > Client-side command for `netperf`, the benchmarking application that measures network throughput. Similar to `iperf`.
-> See also: `netserver` for the server-side command.
+> See also: `netserver`.
 > More information: <https://hewlettpackard.github.io/netperf/doc/netperf.html#Global-Command_002dline-Options>.

 - Connect to server on a specific IP address via default port (12865):
@@ -1,7 +1,7 @@
 # netserver

 > Server-side command for `netperf`, the benchmarking application that measures network throughput.
-> See also: `netperf` for the client-side command.
+> See also: `netperf`.
 > More information: <https://manned.org/netserver>.

 - Start a server on the default port (12865) and fork to background:
@@ -1,7 +1,7 @@
 # nix build

 > Build a Nix expression (downloading from the cache when possible).
-> See also: `nix-build` for information about traditional Nix builds from expressions, `nix flake` for information about flakes.
+> See also: `nix-build`, `nix flake`.
 > More information: <https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-build.html>.

 - Build a package from nixpkgs, symlinking the result to `./result`:
@@ -1,7 +1,7 @@
 # nix registry

 > Manage a Nix flake registry.
-> See also: `nix flake` for information about flakes.
+> See also: `nix flake`.
 > More information: <https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-registry.html>.

 - Pin the `nixpkgs` revision to the current version of the upstream repository:
@@ -1,7 +1,7 @@
 # nix run

 > Run an application from a Nix flake.
-> See also: `nix flake` for information about flakes.
+> See also: `nix flake`.
 > More information: <https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-run.html>.

 - Run the default application in the flake in the current directory:
@@ -1,7 +1,7 @@
 # nix search

 > Search for packages in a Nix flake.
-> See also: `nix flake` for information about flakes.
+> See also: `nix flake`.
 > More information: <https://nix.dev/manual/nix/stable/command-ref/new-cli/nix3-search.html>.

 - Search `nixpkgs` for a package based on its name or description:
@@ -1,7 +1,7 @@
 # nix shell

 > Start a shell in which the specified packages are available.
-> See also: `nix-shell` for setting up development environments, `nix flake` for information about flakes.
+> See also: `nix-shell`, `nix flake`.
 > More information: <https://manned.org/nix3-shell>.

 - Start an interactive shell with some packages from `nixpkgs`:
@@ -2,7 +2,7 @@

 > A powerful package manager that makes package management reliable, reproducible, and declarative.
 > `nix` is experimental and requires enabling experimental features.
-> See also: `nix classic` for a classic, stable interface.
+> See also: `nix classic`.
 > Some subcommands such as `build`, `develop`, `flake`, `registry`, `profile`, `search`, `repl`, `store`, `edit`, `why-depends`, etc. have their own usage documentation.
 > More information: <https://nix.dev/manual/nix/stable/command-ref/new-cli/nix>.

@@ -1,7 +1,7 @@
 # npm login

 > Log in to a registry user account.
-> See also: `npm logout` for logging out.
+> See also: `npm logout`.
 > More information: <https://docs.npmjs.com/cli/npm-login/>.

 - Log in to a registry user account and save the credentials to the `.npmrc` file:
@@ -1,7 +1,7 @@
 # npm logout

 > Log out of the registry user account.
-> See also: `npm login` for logging in.
+> See also: `npm login`.
 > More information: <https://docs.npmjs.com/cli/npm-logout/>.

 - Log out of the registry user account:
@@ -1,7 +1,7 @@
 # popd

 > Remove a directory placed on the directory stack via the pushd shell built-in.
-> See also: `pushd` to place a directory on the stack and `dirs` to display directory stack contents.
+> See also: `pushd`, `dirs`.
 > More information: <https://www.gnu.org/software/bash/manual/bash.html#index-popd>.

 - Remove the top directory from the stack and cd to it:
@@ -1,7 +1,7 @@
 # pushd

 > Place a directory on a stack so it can be accessed later.
-> See also: `popd` to switch back to original directory and `dirs` to display directory stack contents.
+> See also: `popd`, `dirs`.
 > More information: <https://www.gnu.org/software/bash/manual/bash.html#index-pushd>.

 - Switch to directory and push it on the stack:
@@ -2,7 +2,7 @@

 > Markdown note-taking application.
 > Optionally integrates with the note-taking applications of Nextcloud and ownCloud.
-> See also: `qc` for managing command snippets.
+> See also: `qc`.
 > More information: <https://www.qownnotes.org/getting-started/cli-parameters.html>.

 - Run in portable mode:
@@ -2,7 +2,7 @@

 > Set Z shell (`zsh`) options.
 > Note: Zsh options are case-insensitive and underscores are ignored.
-> See also: `unsetopt` to unset options.
+> See also: `unsetopt`.
 > More information: <https://zsh.sourceforge.io/Doc/Release/Options.html>.

 - List enabled options:
@@ -1,7 +1,7 @@
 # sfdk build-shell

 > Execute custom steps in build engine.
-> See also: `sfdk config` for configuring the build target and `sfdk build-init` for initializing build tree.
+> See also: `sfdk config`, `sfdk build-init`.
 > More information: <https://github.com/sailfishos/sailfish-qtcreator/blob/master/share/qtcreator/sfdk/modules/20-building-mb2/doc/command.build-shell.adoc>.

 - Launch interactive shell in the build engine:
@@ -1,7 +1,7 @@
 # sh

 > Bourne shell, the standard command language interpreter.
-> See also: `!` and `^` for history expansion.
+> See also: `!`, `^`.
 > More information: <https://manned.org/sh>.

 - Start an interactive shell session:
@@ -1,7 +1,7 @@
 # speedtest-cli

 > Test internet bandwidth using <https://speedtest.net>.
-> See also: `speedtest` for the official CLI.
+> See also: `speedtest`.
 > More information: <https://github.com/sivel/speedtest-cli>.

 - Run a speed test:
@@ -1,8 +1,8 @@
 # ssh-agent

 > Spawn an SSH Agent process.
-> An SSH Agent holds SSH keys decrypted in memory until removed or the process is killed.
-> See also: `ssh-add`, which can add and manage keys held by an SSH Agent.
+> Note: An SSH Agent holds SSH keys decrypted in memory until removed or the process is killed.
+> See also: `ssh-add`.
 > More information: <https://man.openbsd.org/ssh-agent>.

 - Start an SSH Agent for the current shell:
@@ -1,7 +1,7 @@
 # ssh-keygen

 > Generate SSH keys used for authentication, password-less logins, and other things.
-> See also: `ssh-copy-id` for installing SSH keys on remote hosts.
+> See also: `ssh-copy-id`.
 > More information: <https://man.openbsd.org/ssh-keygen>.

 - Generate a key interactively:
@@ -2,7 +2,7 @@

 > Unset options for the Z shell (`zsh`).
 > Note: Zsh options are case-insensitive and underscores are ignored.
-> See also: `setopt` to set options.
+> See also: `setopt`.
 > More information: <https://zsh.sourceforge.io/Doc/Release/Options.html>.

 - List all currently unset options (use `setopt` to list set options):
@@ -1,7 +1,7 @@
 # wait

 > Wait for a process to complete before proceeding.
-> See also: `ps` to view information about running processes and `waitpid`.
+> See also: `ps`, `waitpid`.
 > More information: <https://www.gnu.org/software/bash/manual/bash.html#index-wait>.

 - Wait for a process to finish given its process ID (PID) and return its exit status:
@@ -1,7 +1,7 @@
 # bspwm

 > A tiling window manager based on binary space partitioning.
-> See also: `bspc` for controlling it.
+> See also: `bspc`.
 > More information: <https://github.com/baskerville/bspwm/blob/master/doc/bspwm.1.asciidoc>.

 - Start `bspwm` (note that a pre-existing window manager must not be open when this command is run):
@@ -1,7 +1,7 @@
 # compsize

 > Calculate the compression ratio of a set of files on a btrfs filesystem.
-> See also: `btrfs filesystem` for recompressing a file by defragmenting it.
+> See also: `btrfs filesystem`.
 > More information: <https://manned.org/compsize>.

 - Calculate the current compression ratio for a file or directory:
@@ -1,7 +1,7 @@
 # extundelete

 > Recover deleted files from ext3 or ext4 partitions by parsing the journal.
-> See also: `date` for Unix time information and `umount` for unmounting partitions.
+> See also: `date`, `umount`.
 > More information: <https://extundelete.sourceforge.net/options.html>.

 - Restore all deleted files inside partition `N` on device `X`:
@@ -1,7 +1,7 @@
 # insmod

 > Dynamically load modules into the Linux Kernel.
-> See also: `kmod` for other module management commands.
+> See also: `kmod`.
 > More information: <https://manned.org/insmod>.

 - Insert a kernel module into the Linux kernel:
@@ -1,7 +1,7 @@
 # ipcs

 > Show information about the usage of System V IPC facilities: shared memory segments, message queues, and semaphore arrays.
-> See also: `lsipc` for a more flexible tool, `ipcmk` for creating IPC facilities, and `ipcrm` for deleting them.
+> See also: `lsipc`, `ipcmk`, `ipcrm`.
 > More information: <https://manned.org/ipcs>.

 - Show information about all active IPC facilities:
@@ -1,7 +1,7 @@
 # lsipc

 > Show information on System V IPC facilities currently employed in the system.
-> See also: `ipcs` for the older tool.
+> See also: `ipcs`.
 > More information: <https://manned.org/lsipc>.

 - Show information about all active IPC facilities:
@@ -1,7 +1,7 @@
 # lsmod

 > Show the status of Linux kernel modules.
-> See also: `kmod` for other module management commands.
+> See also: `kmod`.
 > More information: <https://manned.org/lsmod>.

 - List all currently loaded kernel modules:
@@ -1,7 +1,7 @@
 # modinfo

 > Extract information about a Linux kernel module.
-> See also: `kmod` for other module management commands.
+> See also: `kmod`.
 > More information: <https://manned.org/modinfo>.

 - List all attributes of a kernel module:
@@ -1,7 +1,7 @@
 # modprobe

 > Add or remove modules from the Linux kernel.
-> See also: `kmod` for other module management commands.
+> See also: `kmod`.
 > More information: <https://manned.org/modprobe>.

 - Pretend to load a module into the kernel, but don't actually do it:
@@ -1,7 +1,7 @@
 # mount.ddi

 > Mount Discoverable Disk Images.
-> See also: `systemd-dissect` for other commands relevant to DDIs.
+> See also: `systemd-dissect`.
 > More information: <https://www.freedesktop.org/software/systemd/man/latest/systemd-dissect.html>.

 - Mount an OS image:
@@ -1,7 +1,7 @@
 # pw-dot

 > Create `.dot` files of the PipeWire graph.
-> See also: `dot` for rendering graph.
+> See also: `dot`.
 > More information: <https://docs.pipewire.org/page_man_pw-dot_1.html>.

 - Generate a graph to `pw.dot` file:
@@ -2,7 +2,7 @@

 > Build and manage highly optimised desktop virtual machines quickly.
 > Note: Virtual machine must be in stopped state when working with snapshots.
-> See also: `quickget` for preparing VM configurations.
+> See also: `quickget`.
 > More information: <https://github.com/quickemu-project/quickemu>.

 - Create and run a virtual machine from a configuration file:
@@ -1,7 +1,7 @@
 # rmmod

 > Remove modules from the Linux kernel.
-> See also: `kmod` for other module management commands.
+> See also: `kmod`.
 > More information: <https://manned.org/rmmod>.

 - Remove a module from the kernel:
@@ -1,7 +1,7 @@
 # semanage boolean

 > Manage persistent SELinux boolean settings.
-> See also: `semanage` for managing SELinux policies, `getsebool` for checking boolean values, and `setsebool` for applying non-persistent boolean settings.
+> See also: `semanage`, `getsebool`, `setsebool`.
 > More information: <https://manned.org/semanage-boolean>.

 - List all booleans settings:
@@ -1,7 +1,7 @@
 # sinfo

 > View information about Slurm nodes and partitions.
-> See also: `squeue`, `sbatch`, which are also part of the Slurm workload manager.
+> See also: `squeue`, `sbatch`.
 > More information: <https://slurm.schedmd.com/sinfo.html>.

 - Show a quick summary overview of the cluster:
@@ -1,7 +1,7 @@
 # systemctl daemon-reexec

 > Reexecute systemd while preserving current unit states.
-> See also: `systemctl daemon-reload` for applying changes in unit files.
+> See also: `systemctl daemon-reload`.
 > More information: <https://www.freedesktop.org/software/systemd/man/systemctl.html#daemon-reexec>.

 - Reexecute systemd:
@@ -2,7 +2,7 @@

 > Reload systemd manager configuration.
 > Use this after creating, modifying, or deleting unit files.
-> See also: `systemctl reload` for reloading service configuration.
+> See also: `systemctl reload`.
 > More information: <https://www.freedesktop.org/software/systemd/man/systemctl.html#daemon-reload>.

 - Reload systemd to apply changes in unit files:
@@ -1,7 +1,7 @@
 # systemctl list-dependencies

 > Show a unit's dependency tree in systemd.
-> See also: `systemctl list-units` to list loaded units.
+> See also: `systemctl list-units`.
 > More information: <https://www.freedesktop.org/software/systemd/man/latest/systemctl.html#list-dependencies%20UNIT%E2%80%A6>.

 - Show the dependency tree of `default.target`:
@@ -1,7 +1,7 @@
 # systemctl list-unit-files

 > List installed unit files and their enablement states.
-> See also: `systemctl list-units` for listing units currently loaded in memory.
+> See also: `systemctl list-units`.
 > More information: <https://www.freedesktop.org/software/systemd/man/systemctl.html#list-unit-files%20PATTERN%E2%80%A6>.

 - List installed unit files and their states:
@@ -1,7 +1,7 @@
 # systemctl list-units

 > List units that systemd currently has in memory.
-> See also: `systemctl list-unit-files` for listing installed unit files.
+> See also: `systemctl list-unit-files`.
 > More information: <https://www.freedesktop.org/software/systemd/man/systemctl.html#list-units%20PATTERN%E2%80%A6>.

 - List units which are active, have pending jobs, or have failed:
@@ -1,7 +1,7 @@
 # netstat

 > Display network-related information such as open connections, open socket ports, etc.
-> See also: `lsof` for listing network connections, including listening ports.
+> See also: `lsof`.
 > More information: <https://keith.github.io/xcode-man-pages/netstat.1.html>.

 - Display the PID and program name listening on a specific protocol:
@@ -1,7 +1,7 @@
 # pushd

 > Place a directory on a stack so it can be accessed later.
-> See also: `popd` to switch back to original directory.
+> See also: `popd`.
 > More information: <https://learn.microsoft.com/windows-server/administration/windows-commands/pushd>.

 - Switch to directory and push it on the stack: