util-linux: add option placeholders and properly split posix versions in common (tldr-pages#16037)

Author: Managor

pages/common/logger.md

@@ -1,24 +1,8 @@
 # logger
 
-> Add messages to syslog (/var/log/syslog).
-> More information: <https://manned.org/logger>.
+> Add messages to syslog.
+> More information: <https://manned.org/logger.1p>.
 
 - Log a message to syslog:
 
 `logger {{message}}`
-
-- Take input from `stdin` and log to syslog:
-
-`echo {{log_entry}} | logger`
-
-- Send the output to a remote syslog server running at a given port. Default port is 514:
-
-`echo {{log_entry}} | logger --server {{hostname}} --port {{port}}`
-
-- Use a specific tag for every line logged. Default is the name of logged in user:
-
-`echo {{log_entry}} | logger --tag {{tag}}`
-
-- Log messages with a given priority. Default is `user.notice`. See `man logger` for all priority options:
-
-`echo {{log_entry}} | logger --priority {{user.warning}}`

pages/common/renice.md

@@ -3,20 +3,16 @@
 > Alter the scheduling priority/niceness of running processes.
 > Niceness values range from -20 (most favorable to the process) to 19 (least favorable to the process).
 > See also: `nice`.
-> More information: <https://manned.org/renice>.
+> More information: <https://manned.org/renice.1p>.
 
-- Set the absolute priority of a running process:
+- Increase/decrease the priority of a running [p]rocess:
 
-`renice --priority {{3}} {{[-p|--pid]}} {{pid}}`
+`renice -n {{3}} -p {{pid}}`
 
-- Increase the priority of a running process:
+- Increase/decrease the priority of all processes owned by a [u]ser:
 
-`sudo renice --relative {{-4}} {{[-p|--pid]}} {{pid}}`
+`renice -n {{-4}} -u {{uid|user}}`
 
-- Decrease the priority of all processes owned by a user:
+- Increase/decrease the priority of all processes that belong to a process [g]roup:
 
-`renice --relative {{4}} {{[-u|--user]}} {{uid|user}}`
-
-- Set the priority of all processes that belong to a process group:
-
-`sudo renice {{-5}} {{[-g|--pgrp]}} {{process_group}}`
+`renice -n {{5}} -g {{process_group}}`

pages/common/whereis.md

@@ -2,7 +2,7 @@
 
 > Write a message on the terminal of a specified logged in user (`<Ctrl c>` to stop writing messages).
 > Use the `who` command to find out all terminal_ids of all active users active on the system. See also `mesg`.
-> More information: <https://manned.org/write>.
+> More information: <https://manned.org/write.1p>.
 
 - Send a message to a given user on a given terminal ID:
 

pages/common/write.md

@@ -9,8 +9,8 @@
 
 - Securely discard all blocks on a device, removing all data:
 
-`blkdiscard --secure {{/dev/device}}`
+`blkdiscard {{[-s|--secure]}} {{/dev/device}}`
 
 - Discard the first 100 MB of a device:
 
-`blkdiscard --length {{100MB}} {{/dev/device}}`
+`blkdiscard {{[-l|--length]}} {{100MB}} {{/dev/device}}`

pages/linux/blkdiscard.md

@@ -9,4 +9,4 @@
 
 - List all partitions in a table, including current mountpoints:
 
-`sudo blkid -o list`
+`sudo blkid {{[-o|--output]}} list`

pages/linux/blkid.md

@@ -9,4 +9,4 @@
 
 - Create a new partition table for a specific device and manage it:
 
-`cfdisk --zero {{/dev/sdX}}`
+`cfdisk {{[-z|--zero]}} {{/dev/sdX}}`

pages/linux/cfdisk.md

@@ -5,8 +5,8 @@
 
 - Disable one or more CPUs by their IDs:
 
-`chcpu -d {{1,3}}`
+`chcpu {{[-d|--disable]}} {{1,3}}`
 
 - Enable one or more ranges of CPUs by their IDs:
 
-`chcpu -e {{1-3,5-7}}`
+`chcpu {{[-e|--enable]}} {{1-3,5-7}}`

pages/linux/chcpu.md

@@ -5,12 +5,12 @@
 
 - Display the OOM-killer score of the process with a specific ID:
 
-`choom -p {{pid}}`
+`choom {{[-p|--pid]}} {{pid}}`
 
 - Change the adjust OOM-killer score of a specific process:
 
-`choom -p {{pid}} -n {{-1000..+1000}}`
+`choom {{[-p|--pid]}} {{pid}} {{[-n|--adjust]}} {{-1000..+1000}}`
 
 - Run a command with a specific adjust OOM-killer score:
 
-`choom -n {{-1000..+1000}} {{command}} {{argument1 argument2 ...}}`
+`choom {{[-n|--adjust]}} {{-1000..+1000}} {{command}} {{argument1 argument2 ...}}`

pages/linux/choom.md

@@ -5,20 +5,20 @@
 
 - Display attributes of a process:
 
-`chrt --pid {{PID}}`
+`chrt {{[-p|--pid]}} {{PID}}`
 
 - Display attributes of all threads of a process:
 
-`chrt --all-tasks --pid {{PID}}`
+`chrt {{[-a|--all-tasks]}} {{[-p|--pid]}} {{PID}}`
 
 - Display the min/max priority values that can be used with `chrt`:
 
-`chrt --max`
+`chrt {{[-m|--max]}}`
 
 - Set the scheduling priority of a process:
 
-`chrt --pid {{priority}} {{PID}}`
+`chrt {{[-p|--pid]}} {{priority}} {{PID}}`
 
 - Set the scheduling policy of a process:
 
-`chrt --{{deadline|idle|batch|rr|fifo|other}} --pid {{priority}} {{PID}}`
+`chrt --{{deadline|idle|batch|rr|fifo|other}} {{[-p|--pid]}} {{priority}} {{PID}}`

pages/linux/chrt.md

@@ -6,12 +6,12 @@
 
 - Reserve a file taking up 700 MiB of disk space:
 
-`fallocate --length {{700M}} {{path/to/file}}`
+`fallocate {{[-l|--length]}} {{700M}} {{path/to/file}}`
 
 - Shrink an already allocated file by 200 MiB:
 
-`fallocate --collapse-range --length {{200M}} {{path/to/file}}`
+`fallocate {{[-c|--collapse-range]}} {{[-l|--length]}} {{200M}} {{path/to/file}}`
 
 - Shrink 20 MB of space after 100 MiB in a file:
 
-`fallocate --collapse-range --offset {{100M}} --length {{20M}} {{path/to/file}}`
+`fallocate {{[-c|--collapse-range]}} {{[-o|--offset]}} {{100M}} {{[-l|--length]}} {{20M}} {{path/to/file}}`

pages/common/column.md pages/linux/column.md

@@ -17,12 +17,12 @@
 
 - Find filesystems in specific type:
 
-`findmnt -t {{ext4}}`
+`findmnt {{[-t|--types]}} {{ext4}}`
 
 - Find filesystems with specific label:
 
 `findmnt LABEL={{BigStorage}}`
 
 - Check mount table content in detail and verify `/etc/fstab`:
 
-`findmnt --verify --verbose`
+`findmnt {{[-x|--verify]}} --verbose`

pages/linux/fallocate.md

@@ -6,12 +6,12 @@
 
 - Run a command with a file lock as soon as the lock is not required by others:
 
-`flock {{path/to/lock.lock}} --command "{{command}}"`
+`flock {{path/to/lock.lock}} {{[-c|--command]}} "{{command}}"`
 
 - Run a command with a file lock, and exit if the lock doesn't exist:
 
-`flock {{path/to/lock.lock}} --nonblock --command "{{command}}"`
+`flock {{path/to/lock.lock}} {{[-n|--nonblock]}} {{[-c|--command]}} "{{command}}"`
 
 - Run a command with a file lock, and exit with a specific error code if the lock doesn't exist:
 
-`flock {{path/to/lock.lock}} --nonblock --conflict-exit-code {{error_code}} -c "{{command}}"`
+`flock {{path/to/lock.lock}} {{[-n|--nonblock]}} {{[-E|--conflict-exit-code]}} {{error_code}} {{[-c|--command]}} "{{command}}"`

pages/linux/findmnt.md

@@ -6,12 +6,12 @@
 
 - Trim unused blocks on all mounted partitions that support it:
 
-`sudo fstrim --all`
+`sudo fstrim {{[-a|--all]}}`
 
 - Trim unused blocks on a specified partition:
 
 `sudo fstrim {{/}}`
 
 - Display statistics after trimming:
 
-`sudo fstrim --verbose {{/}}`
+`sudo fstrim {{[-v|--verbose]}} {{/}}`

pages/common/flock.md pages/linux/flock.md

@@ -9,12 +9,12 @@
 
 - Display the input offset in hexadecimal and its ASCII representation in two columns:
 
-`hexdump -C {{path/to/file}}`
+`hexdump {{[-C|--canonical]}} {{path/to/file}}`
 
 - Display the hexadecimal representation of a file, but interpret only n bytes of the input:
 
-`hexdump -C -n{{number_of_bytes}} {{path/to/file}}`
+`hexdump {{[-C|--canonical]}} {{[-n|--length]}} {{number_of_bytes}} {{path/to/file}}`
 
 - Don't replace duplicate lines with '*':
 
-`hexdump --no-squeezing {{path/to/file}}`
+`hexdump {{[-v|--no-squeezing]}} {{path/to/file}}`

pages/linux/fstrim.md

@@ -9,8 +9,8 @@
 
 - Write the current software clock time to the hardware clock (sometimes used during system setup):
 
-`hwclock --systohc`
+`hwclock {{[-w|--systohc]}}`
 
 - Write the current hardware clock time to the software clock:
 
-`hwclock --hctosys`
+`hwclock {{[-s|--hctosys]}}`

pages/common/hexdump.md pages/linux/hexdump.md

@@ -5,28 +5,28 @@
 
 - Delete a shared memory segment by ID:
 
-`ipcrm --shmem-id {{shmem_id}}`
+`ipcrm {{[-m|--shmem-id]}} {{shmem_id}}`
 
 - Delete a shared memory segment by key:
 
-`ipcrm --shmem-key {{shmem_key}}`
+`ipcrm {{[-M|--shmem-key]}} {{shmem_key}}`
 
 - Delete an IPC queue by ID:
 
-`ipcrm --queue-id {{ipc_queue_id}}`
+`ipcrm {{[-q|--queue-id]}} {{ipc_queue_id}}`
 
 - Delete an IPC queue by key:
 
-`ipcrm --queue-key {{ipc_queue_key}}`
+`ipcrm {{[-Q|--queue-key]}} {{ipc_queue_key}}`
 
 - Delete a semaphore by ID:
 
-`ipcrm --semaphore-id {{semaphore_id}}`
+`ipcrm {{[-s|--semaphore-id]}} {{semaphore_id}}`
 
 - Delete a semaphore by key:
 
-`ipcrm --semaphore-key {{semaphore_key}}`
+`ipcrm {{[-S|--semaphore-key]}} {{semaphore_key}}`
 
 - Delete all IPC resources:
 
-`ipcrm --all`
+`ipcrm {{[-a|--all]}}`

pages/linux/hwclock.md

@@ -9,8 +9,8 @@
 
 - Display the block count and block size of an ISO file:
 
-`isosize --sectors {{path/to/file.iso}}`
+`isosize {{[-x|--sectors]}} {{path/to/file.iso}}`
 
 - Display the size of an ISO file divided by a given number (only usable when --sectors is not given):
 
-`isosize --divisor={{number}} {{path/to/file.iso}}`
+`isosize {{[-d|--divisor]}} {{number}} {{path/to/file.iso}}`

pages/linux/ipcrm.md

@@ -9,16 +9,16 @@
 
 - List all last logged in users since a given time:
 
-`sudo lastb --since {{YYYY-MM-DD}}`
+`sudo lastb {{[-s|--since]}} {{YYYY-MM-DD}}`
 
 - List all last logged in users until a given time:
 
-`sudo lastb --until {{YYYY-MM-DD}}`
+`sudo lastb {{[-t|--until]}} {{YYYY-MM-DD}}`
 
 - List all logged in users at a specific time:
 
-`sudo lastb --present {{hh:mm}}`
+`sudo lastb {{[-p|--present]}} {{hh:mm}}`
 
 - List all last logged in users and translate the IP into a hostname:
 
-`sudo lastb --dns`
+`sudo lastb {{[-d|--dns]}}`

pages/linux/isosize.md

@@ -0,0 +1,24 @@
+# logger
+
+> Add messages to syslog (/var/log/syslog).
+> More information: <https://manned.org/logger>.
+
+- Log a message to syslog:
+
+`logger {{message}}`
+
+- Take input from `stdin` and log to syslog:
+
+`echo {{log_entry}} | logger`
+
+- Send the output to a remote syslog server running at a given port. Default port is 514:
+
+`echo {{log_entry}} | logger {{[-n|--server]}} {{hostname}} {{[-P|--port]}} {{port}}`
+
+- Use a specific tag for every line logged. Default is the name of logged in user:
+
+`echo {{log_entry}} | logger {{[-t|--tag]}} {{tag}}`
+
+- Log messages with a given priority. Default is `user.notice`. See `man logger` for all priority options:
+
+`echo {{log_entry}} | logger {{[-p|--priority]}} {{user.warning}}`

pages/common/last.md pages/linux/last.md

@@ -5,24 +5,24 @@
 
 - List loop devices with detailed info:
 
-`losetup -a`
+`losetup {{[-a|--all]}}`
 
 - Attach a file to a given loop device:
 
 `sudo losetup {{/dev/loop}} /{{path/to/file}}`
 
 - Attach a file to a new free loop device and scan the device for partitions:
 
-`sudo losetup --show --partscan -f /{{path/to/file}}`
+`sudo losetup --show {{[-P|--partscan]}} {{[-f|--find]}} /{{path/to/file}}`
 
 - Attach a file to a read-only loop device:
 
-`sudo losetup --read-only {{/dev/loop}} /{{path/to/file}}`
+`sudo losetup {{[-r|--read-only]}} {{/dev/loop}} /{{path/to/file}}`
 
 - Detach all loop devices:
 
-`sudo losetup -D`
+`sudo losetup {{[-D|--detach-all]}}`
 
 - Detach a given loop device:
 
-`sudo losetup -d {{/dev/loop}}`
+`sudo losetup {{[-d|--detach]}} {{/dev/loop}}`