Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Aug 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pages/common/at.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/base32.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pages/common/base64.md
Original file line number Diff line number Diff line change
@@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion pages/common/basenc.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pages/common/bat.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
4 changes: 2 additions & 2 deletions pages/common/batch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/bison.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/bzip2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/bzip3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/carbon-now.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/cat.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/cmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/column.md
Original file line number Diff line number Diff line change
@@ -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>.

Expand Down
2 changes: 1 addition & 1 deletion pages/common/cpio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
4 changes: 2 additions & 2 deletions pages/common/expand.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/fold.md
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion pages/common/gh-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
4 changes: 2 additions & 2 deletions pages/common/git-archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/git-bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
6 changes: 3 additions & 3 deletions pages/common/git-column.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`
2 changes: 1 addition & 1 deletion pages/common/git-stripspace.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pages/common/gnomon.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/goimports.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
6 changes: 3 additions & 3 deletions pages/common/gpg2.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@

`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}}`

- Import a public key:

`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 {{[email protected]}}`

- 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 {{[email protected]}}`
4 changes: 2 additions & 2 deletions pages/common/hashid.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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}}`
2 changes: 1 addition & 1 deletion pages/common/mail.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pages/common/msmtp.md
Original file line number Diff line number Diff line change
@@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion pages/common/mutool.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
4 changes: 2 additions & 2 deletions pages/common/nl.md
Original file line number Diff line number Diff line change
@@ -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}} -`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/pdftotext.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}} -`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/pueue-follow.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@

`pueue follow {{task_id}}`

- Follow the `stderr` of a task:
- Follow `stderr` of a task:

`pueue follow --err {{task_id}}`
2 changes: 1 addition & 1 deletion pages/common/pygmentize.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/sops.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`

Expand Down
6 changes: 3 additions & 3 deletions pages/common/stdbuf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}`
6 changes: 3 additions & 3 deletions pages/common/tee.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# 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}}`

- Append to the given files, do not overwrite:

`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]"}}`

Expand Down
2 changes: 1 addition & 1 deletion pages/common/ts.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Loading