pages/*: add backticks around I/O streams (#10436)

* as suggested in #10428
* standard input  => `stdin`
* standard output => `stdout`
* standard error  => `stderr`

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
pull/23/head
Lena 2023-08-09 07:29:02 +02:00 committed by GitHub
parent eb690c280d
commit d427f333b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
60 changed files with 77 additions and 77 deletions

View File

@ -4,11 +4,11 @@
> Service atd (or atrun) should be running for the actual executions.
> More information: <https://manned.org/at>.
- Execute commands from standard input in 5 minutes (press `Ctrl + D` when done):
- Execute commands from `stdin` in 5 minutes (press `Ctrl + D` when done):
`at now + 5 minutes`
- Execute a command from standard input at 10:00 AM today:
- Execute a command from `stdin` at 10:00 AM today:
`echo "{{./make_db_backup.sh}}" | at 1000`

View File

@ -1,6 +1,6 @@
# base32
> Encode or decode file or standard input to/from Base32, to standard output.
> Encode or decode file or `stdin` to/from Base32, to `stdout`.
> More information: <https://www.gnu.org/software/coreutils/base32>.
- Encode a file:

View File

@ -1,6 +1,6 @@
# base64
> Encode or decode file or standard input to/from Base64, to standard output.
> Encode or decode file or `stdin` to/from Base64, to `stdout`.
> More information: <https://www.gnu.org/software/coreutils/base64>.
- Encode the contents of a file as base64 and write the result to `stdout`:

View File

@ -1,6 +1,6 @@
# basenc
> Encode or decode file or standard input using a specified encoding, to standard output.
> Encode or decode file or `stdin` using a specified encoding, to `stdout`.
> More information: <https://www.gnu.org/software/coreutils/basenc>.
- Encode a file with base64 encoding:

View File

@ -4,7 +4,7 @@
> A `cat` clone with syntax highlighting and Git integration.
> More information: <https://github.com/sharkdp/bat>.
- Print the contents of a file to the standard output:
- Print the contents of a file to `stdout`:
`bat {{path/to/file}}`

View File

@ -4,11 +4,11 @@
> Service atd (or atrun) should be running for the actual executions.
> More information: <https://manned.org/batch>.
- Execute commands from standard input (press `Ctrl + D` when done):
- Execute commands from `stdin` (press `Ctrl + D` when done):
`batch`
- Execute a command from standard input:
- Execute a command from `stdin`:
`echo "{{./make_db_backup.sh}}" | batch`

View File

@ -7,7 +7,7 @@
`bison {{path/to/file.y}}`
- Compile in debug mode, which causes the resulting parser to write additional information to the standard output:
- Compile in debug mode, which causes the resulting parser to write additional information to `stdout`:
`bison --debug {{path/to/file.y}}`

View File

@ -11,7 +11,7 @@
`bzip2 -d {{path/to/compressed_file.bz2}}`
- Decompress a file to standard output:
- Decompress a file to `stdout`:
`bzip2 -dc {{path/to/compressed_file.bz2}}`

View File

@ -11,7 +11,7 @@
`bzip3 -d {{path/to/compressed_file.bz3}}`
- Decompress a file to standard output:
- Decompress a file to `stdout`:
`bzip3 -dc {{path/to/compressed_file.bz3}}`

View File

@ -11,7 +11,7 @@
`carbon-now --from-clipboard`
- Create an image from standard input using default settings:
- Create an image from `stdin` using default settings:
`{{input}} | carbon-now`

View File

@ -3,7 +3,7 @@
> Print and concatenate files.
> More information: <https://www.gnu.org/software/coreutils/cat>.
- Print the contents of a file to the standard output:
- Print the contents of a file to `stdout`:
`cat {{path/to/file}}`

View File

@ -7,7 +7,7 @@
`cmark --to html {{filename.md}}`
- Convert data from standard input to LaTeX:
- Convert data from `stdin` to LaTeX:
`cmark --to latex`

View File

@ -1,6 +1,6 @@
# column
> Format standard input or a file into multiple columns.
> Format `stdin` or a file into multiple columns.
> Columns are filled before rows; the default separator is a whitespace.
> More information: <https://manned.org/column>.

View File

@ -4,7 +4,7 @@
> Supports the following archive formats: cpio's custom binary, old ASCII, new ASCII, crc, HPUX binary, HPUX old ASCII, old tar, and POSIX.1 tar.
> More information: <https://www.gnu.org/software/cpio>.
- Take a list of file names from standard input and add them [o]nto an archive in cpio's binary format:
- Take a list of file names from `stdin` and add them [o]nto an archive in cpio's binary format:
`echo "{{file1}} {{file2}} {{file3}}" | cpio -o > {{archive.cpio}}`

View File

@ -3,11 +3,11 @@
> Convert tabs to spaces.
> More information: <https://www.gnu.org/software/coreutils/expand>.
- Convert tabs in each file to spaces, writing to standard output:
- Convert tabs in each file to spaces, writing to `stdout`:
`expand {{path/to/file}}`
- Convert tabs to spaces, reading from standard input:
- Convert tabs to spaces, reading from `stdin`:
`expand`

View File

@ -1,6 +1,6 @@
# fold
> Wraps each line in an input file to fit a specified width and prints it to the standard output.
> Wrap each line in an input file to fit a specified width and print it to `stdout`.
> More information: <https://manned.org/fold.1p>.
- Wrap each line to default width (80 characters):

View File

@ -7,7 +7,7 @@
`gh auth login`
- Log in with a token from standard input (created in https://github.com/settings/tokens):
- Log in with a token from `stdin` (created in https://github.com/settings/tokens):
`echo {{your_token}} | gh auth login --with-token`

View File

@ -3,11 +3,11 @@
> Create an archive of files from a named tree.
> More information: <https://git-scm.com/docs/git-archive>.
- Create a tar archive from the contents of the current HEAD and print it to standard output:
- Create a tar archive from the contents of the current HEAD and print it to `stdout`:
`git archive --verbose HEAD`
- Create a zip archive from the current HEAD and print it to standard output:
- Create a zip archive from the current HEAD and print it to `stdout`:
`git archive --verbose --format=zip HEAD`

View File

@ -23,7 +23,7 @@
`git bundle verify {{path/to/file.bundle}}`
- Print to the standard output the list of references contained in a bundle:
- Print to `stdout` the list of references contained in a bundle:
`git bundle unbundle {{path/to/file.bundle}}`

View File

@ -3,14 +3,14 @@
> Display data in columns.
> More information: <https://git-scm.com/docs/git-column>.
- Format the standard input as multiple columns:
- Format `stdin` as multiple columns:
`ls | git column --mode={{column}}`
- Format the standard input as multiple columns with a maximum width of `100`:
- Format `stdin` as multiple columns with a maximum width of `100`:
`ls | git column --mode=column --width={{100}}`
- Format the standard input as multiple columns with a maximum padding of `30`:
- Format `stdin` as multiple columns with a maximum padding of `30`:
`ls | git column --mode=column --padding={{30}}`

View File

@ -1,6 +1,6 @@
# git stripspace
> Read text (e.g. commit messages, notes, tags, and branch descriptions) from the standard input and clean it into the manner used by Git.
> Read text (e.g. commit messages, notes, tags, and branch descriptions) from `stdin` and clean it into the manner used by Git.
> More information: <https://git-scm.com/docs/git-stripspace>.
- Trim whitespace from a file:

View File

@ -3,7 +3,7 @@
> Utility to annotate console logging statements with timestamps and find slow processes.
> More information: <https://github.com/paypal/gnomon>.
- Use UNIX (or DOS) pipes to pipe the `stdout` of any command through gnomon:
- Use UNIX (or DOS) pipes to pipe `stdout` of any command through gnomon:
`{{npm test}} | gnomon`

View File

@ -7,7 +7,7 @@
`goimports {{path/to/file}}.go`
- Write the result back to the source file instead of the standard output:
- Write the result back to the source file instead of `stdout`:
`goimports -w {{path/to/file}}.go`

View File

@ -16,7 +16,7 @@
`gpg2 --symmetric {{path/to/doc.txt}}`
- Decrypt a specified file, writing the result to the standard output:
- Decrypt a specified file, writing the result to `stdout`:
`gpg2 --decrypt {{path/to/doc.txt.gpg}}`
@ -24,10 +24,10 @@
`gpg2 --import {{path/to/public_key.gpg}}`
- Export the public key of a specified email address to the standard output:
- Export the public key of a specified email address to `stdout`:
`gpg2 --export --armor {{alice@example.com}}`
- Export the private key with a specified email address to the standard output:
- Export the private key with a specified email address to `stdout`:
`gpg2 --export-secret-keys --armor {{alice@example.com}}`

View File

@ -3,7 +3,7 @@
> Python3 program that identifies data and password hashes.
> More information: <https://github.com/psypanda/hashID>.
- Identify hashes from standard input (through typing, copying and pasting, or piping the hash into the program):
- Identify hashes from `stdin` (through typing, copying and pasting, or piping the hash into the program):
`hashid`
@ -23,6 +23,6 @@
`hashid --mode --john {{hash}}`
- Save output to a file instead of printing to standard output:
- Save output to a file instead of printing to `stdout`:
`hashid --outfile {{path/to/output.txt}} {{hash}}`

View File

@ -1,7 +1,7 @@
# mail
> The command operates on the user's mailbox if no argument is given.
> To send an email the message body is built from standard input.
> To send an email the message body is built from `stdin`.
> More information: <https://manned.org/mail>.
- Send a typed email message. The command-line below continues after pressing Enter key. Input CC email-id (optional) press Enter key. Input message text (can be multiline). Press Ctrl-D key to complete the message text:

View File

@ -1,7 +1,7 @@
# msmtp
> An SMTP client.
> It reads text from standard input and sends it to an SMTP server.
> It reads text from `stdin` and sends it to an SMTP server.
> More information: <https://marlam.de/msmtp>.
- Send an email using the default account configured in `~/.msmtprc`:

View File

@ -7,7 +7,7 @@
`mutool convert -o {{path/to/output%nd.png}} {{path/to/input.pdf}} {{1-10}}`
- Convert pages 2, 3 and 5 of a PDF into text in the standard output:
- Convert pages 2, 3 and 5 of a PDF into text in `stdout`:
`mutool draw -F {{txt}} {{path/to/input.pdf}} {{2,3,5}}`

View File

@ -1,13 +1,13 @@
# nl
> A utility for numbering lines, either from a file, or from standard input.
> A utility for numbering lines, either from a file, or from `stdin`.
> More information: <https://www.gnu.org/software/coreutils/nl>.
- Number non-blank lines in a file:
`nl {{path/to/file}}`
- Read from standard output:
- Read from `stdout`:
`cat {{path/to/file}} | nl {{options}} -`

View File

@ -3,7 +3,7 @@
> Convert PDF files to plain text format.
> More information: <https://www.xpdfreader.com/pdftotext-man.html>.
- Convert `filename.pdf` to plain text and print it to standard output:
- Convert `filename.pdf` to plain text and print it to `stdout`:
`pdftotext {{filename.pdf}} -`

View File

@ -8,6 +8,6 @@
`pueue follow {{task_id}}`
- Follow the `stderr` of a task:
- Follow `stderr` of a task:
`pueue follow --err {{task_id}}`

View File

@ -3,7 +3,7 @@
> Python-based syntax highlighter.
> More information: <https://pygments.org/docs/cmdline/>.
- Highlight file syntax and print to standard output (language is inferred from the file extension):
- Highlight file syntax and print to `stdout` (language is inferred from the file extension):
`pygmentize {{file.py}}`

View File

@ -8,7 +8,7 @@
`sops -e {{path/to/myfile.json}} > {{path/to/myfile.enc.json}}`
- Decrypt a file to the standard output:
- Decrypt a file to `stdout`:
`sops -d {{path/to/myfile.enc.json}}`

View File

@ -3,14 +3,14 @@
> Run a command with modified buffering operations for its standard streams.
> More information: <https://www.gnu.org/software/coreutils/stdbuf>.
- Change the standard input buffer size to 512 KiB:
- Change `stdin` buffer size to 512 KiB:
`stdbuf --input={{512K}} {{command}}`
- Change the standard output buffer to line-buffered:
- Change `stdout` buffer to line-buffered:
`stdbuf --output={{L}} {{command}}`
- Change the standard error buffer to unbuffered:
- Change `stderr` buffer to unbuffered:
`stdbuf --error={{0}} {{command}}`

View File

@ -1,9 +1,9 @@
# tee
> Read from standard input and write to standard output and files (or commands).
> Read from `stdin` and write to `stdout` and files (or commands).
> More information: <https://www.gnu.org/software/coreutils/tee>.
- Copy standard input to each file, and also to standard output:
- Copy `stdin` to each file, and also to `stdout`:
`echo "example" | tee {{path/to/file}}`
@ -11,7 +11,7 @@
`echo "example" | tee -a {{path/to/file}}`
- Print standard input to the terminal, and also pipe it into another program for further processing:
- Print `stdin` to the terminal, and also pipe it into another program for further processing:
`echo "example" | tee {{/dev/tty}} | {{xargs printf "[%s]"}}`

View File

@ -1,6 +1,6 @@
# ts
> Add timestamps to every line from standard input.
> Add timestamps to every line from `stdin`.
> More information: <https://joeyh.name/code/moreutils/>.
- Add a timestamp to the beginning of each line:

View File

@ -3,11 +3,11 @@
> Convert spaces to tabs.
> More information: <https://www.gnu.org/software/coreutils/unexpand>.
- Convert blanks in each file to tabs, writing to standard output:
- Convert blanks in each file to tabs, writing to `stdout`:
`unexpand {{path/to/file}}`
- Convert blanks to tabs, reading from standard output:
- Convert blanks to tabs, reading from `stdout`:
`unexpand`

View File

@ -3,10 +3,10 @@
> Print data from gzip compressed files.
> More information: <https://www.gnu.org/software/gzip/manual/gzip.html>.
- Print the uncompressed contents of a gzipped file to the standard output:
- Print the uncompressed contents of a gzipped file to `stdout`:
`zcat {{file.txt.gz}}`
- Print compression details of a gzipped file to the standard output:
- Print compression details of a gzipped file to `stdout`:
`zcat -l {{file.txt.gz}}`

View File

@ -7,7 +7,7 @@
`aspell check {{path/to/file}}`
- List misspelled words from standard input:
- List misspelled words from `stdin`:
`cat {{path/to/file}} | aspell list`
@ -19,6 +19,6 @@
`aspell --lang={{cs}}`
- List misspelled words from standard input and ignore words from personal word list:
- List misspelled words from `stdin` and ignore words from personal word list:
`cat {{path/to/file}} | aspell --personal={{personal-word-list.pws}} list`

View File

@ -3,7 +3,7 @@
> Print and concatenate files.
> More information: <https://www.gnu.org/software/coreutils/cat>.
- Print the contents of a file to the standard output:
- Print the contents of a file to `stdout`:
`cat {{path/to/file}}`

View File

@ -1,6 +1,6 @@
# dmesg
> Write the kernel messages to standard output.
> Write the kernel messages to `stdout`.
> More information: <https://manned.org/dmesg>.
- Show kernel messages:

View File

@ -24,7 +24,7 @@
`flameshot screen --number {{2}}`
- Create a screenshot and print it to the standard output:
- Create a screenshot and print it to `stdout`:
`flameshot gui --raw`

View File

@ -1,7 +1,7 @@
# grub-script-check
> The program `grub-script-check` takes a GRUB script file and checks it for syntax errors.
> It may take a path as a non-option argument. If none is supplied, it will read from standard input.
> It may take a path as a non-option argument. If none is supplied, it will read from `stdin`.
> More information: <https://www.gnu.org/software/grub/manual/grub/html_node/Invoking-grub_002dscript_002dcheck.html>.
- Check a specific script file for syntax errors:

View File

@ -7,7 +7,7 @@
`hardinfo`
- Print report to standard output:
- Print report to `stdout`:
`hardinfo -r`

View File

@ -15,7 +15,7 @@
`keyctl add {{type_keyring}} {{key_name}} {{key_value}} {{target_keyring}}`
- Store a key with its value from standard input:
- Store a key with its value from `stdin`:
`echo -n {{key_value}} | keyctl padd {{type_keyring}} {{key_name}} {{target_keyring}}`

View File

@ -7,7 +7,7 @@
`logsave {{path/to/logfile}} {{command}}`
- Take input from standard input and save it in a log file:
- Take input from `stdin` and save it in a log file:
`logsave {{logfile}} -`

View File

@ -3,7 +3,7 @@
> Like cat but more colorful :).
> More information: <https://github.com/lunasorcery/pridecat>.
- Print the contents of a file in pride colors to the standard output:
- Print the contents of a file in pride colors to `stdout`:
`pridecat {{path/to/file}}`

View File

@ -11,7 +11,7 @@
`sudo rmmod --verbose {{module_name}}`
- Remove a module from the kernel and send errors to syslog instead of standard error:
- Remove a module from the kernel and send errors to syslog instead of `stderr`:
`sudo rmmod --syslog {{module_name}}`

View File

@ -16,7 +16,7 @@
`run-mailcap --action=ACTION --debug {{filename}}`
- Ignore any "copiousoutput" directive and forward output to standard output:
- Ignore any "copiousoutput" directive and forward output to `stdout`:
`run-mailcap --action=ACTION --nopager {{filename}}`

View File

@ -15,6 +15,6 @@
`script -a {{path/to/session.out}}`
- Record timing information (data is outputted to the standard error):
- Record timing information (data is outputted to `stderr`):
`script -t 2> {{path/to/timingfile}}`

View File

@ -1,6 +1,6 @@
# scriptreplay
> Replay a typescript created by the `script` command to the standard output.
> Replay a typescript created by the `script` command to `stdout`.
> More information: <https://manned.org/scriptreplay>.
- Replay a typescript at the speed it was recorded:

View File

@ -3,7 +3,7 @@
> Get a selection of the screen.
> More information: <https://github.com/naelstrof/slop>.
- Wait for the user to make a selection and output its geometry to standard output:
- Wait for the user to make a selection and output its geometry to `stdout`:
`slop`

View File

@ -1,6 +1,6 @@
# sqfscat
> Concatenate files from a squashfs filesystem and print them to standard output.
> Concatenate files from a squashfs filesystem and print them to `stdout`.
> More information: <https://manned.org/sqfscat>.
- Display the contents of one or more files from a squashfs filesystem:

View File

@ -11,7 +11,7 @@
`sxiv -f {{path/to/file}}`
- Open a newline-separated list of images, reading filenames from standard input:
- Open a newline-separated list of images, reading filenames from `stdin`:
`echo {{path/to/file}} | sxiv -i`

View File

@ -3,7 +3,7 @@
> Dump and load btmp, utmp and wtmp accounting files.
> More information: <https://manned.org/utmpdump>.
- Dump the `/var/log/wtmp` file to the standard output as plain text:
- Dump the `/var/log/wtmp` file to `stdout` as plain text:
`utmpdump {{/var/log/wtmp}}`

View File

@ -3,7 +3,7 @@
> Print and concatenate files.
> More information: <https://keith.github.io/xcode-man-pages/cat.1.html>.
- Print the contents of a file to the standard output:
- Print the contents of a file to `stdout`:
`cat {{path/to/file}}`

View File

@ -1,6 +1,6 @@
# dmesg
> Write the kernel messages to standard output.
> Write the kernel messages to `stdout`.
> More information: <https://www.manpagez.com/man/8/dmesg/>.
- Show kernel messages:

View File

@ -1,6 +1,6 @@
# pbpaste
> Send the contents of the clipboard to standard output.
> Send the contents of the clipboard to `stdout`.
> Comparable to pressing Cmd + V on the keyboard.
> More information: <https://ss64.com/osx/pbpaste.html>.

View File

@ -19,6 +19,6 @@
`wc -m {{path/to/file}}`
- Use standard input to count lines, words and characters (bytes) in that order:
- Use `stdin` to count lines, words and characters (bytes) in that order:
`{{find .}} | wc`

View File

@ -1,6 +1,6 @@
# dmesg
> Write the kernel messages to standard output.
> Write the kernel messages to `stdout`.
> More information: <https://www.unix.com/man-page/sunos/1m/dmesg>.
- Show kernel messages: