From 5871f35fe812d1fbd274ad2c29a707c608023591 Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Wed, 26 Mar 2025 00:18:43 +0000 Subject: [PATCH] Update cheatsheets --- tldr/at | 8 +++++++ tldr/aws-s3-sync | 41 +++++++++++++++++++++++++++++++++ tldr/browsh | 4 ++++ tldr/btop | 4 ++++ tldr/busybox | 19 +++++++++++++++ tldr/carbonyl | 4 ++++ tldr/case | 4 ++++ tldr/docker-system | 2 +- tldr/function | 4 ++++ tldr/gettext | 4 ++++ tldr/git-init | 4 ++-- tldr/hash | 4 ++++ tldr/iperf | 12 +++++----- tldr/iperf3 | 10 ++++---- tldr/linux/apachectl | 4 ++++ tldr/linux/aurpublish | 4 ++++ tldr/linux/avahi-browse | 8 +++---- tldr/linux/avahi-resolve | 4 ++-- tldr/linux/bridge | 4 ++++ tldr/linux/chage | 14 +++++++---- tldr/linux/cu | 4 ++++ tldr/linux/dialog | 4 ++++ tldr/linux/fadvise | 2 +- tldr/linux/fincore | 4 ++++ tldr/linux/fluidsynth | 4 ++++ tldr/linux/gtk-launch | 4 ++++ tldr/linux/ifstatus | 4 ++++ tldr/linux/informant | 2 +- tldr/linux/ip-maddress | 4 ++++ tldr/linux/iwinfo | 4 ++++ tldr/linux/kwallet-query | 4 ++++ tldr/linux/libinput | 2 +- tldr/linux/loginctl | 4 ++++ tldr/linux/logread | 4 ++++ tldr/linux/lsfd | 4 ++++ tldr/linux/lslogins | 10 ++++---- tldr/linux/lxc-attach | 4 ++++ tldr/linux/lxc-console | 4 ++++ tldr/linux/lxc-create | 4 ++++ tldr/linux/lxc-destroy | 4 ++++ tldr/linux/lxc-info | 4 ++++ tldr/linux/lxc-ls | 4 ++++ tldr/linux/lxc-start | 4 ++++ tldr/linux/lxc-stop | 4 ++++ tldr/linux/minicom | 4 ++++ tldr/linux/nstat | 4 ++++ tldr/linux/parted | 4 ++++ tldr/linux/parted-interactive | 4 ++++ tldr/linux/pg | 4 ++++ tldr/linux/pw-cat | 4 ++++ tldr/linux/pw-reserve | 4 ++++ tldr/linux/pw-v4l2 | 4 ++++ tldr/linux/qmake | 4 ++++ tldr/linux/reflector | 4 ++++ tldr/linux/systemd-ask-password | 4 ++++ tldr/linux/ubuntu-drivers | 4 ++++ tldr/linux/ubus | 4 ++++ tldr/linux/uci | 4 ++++ tldr/linux/usermod | 10 +++++++- tldr/linux/waypipe | 4 ++++ tldr/local | 4 ++++ tldr/ls | 2 +- tldr/magick-mogrify | 4 ++++ tldr/mail | 4 ++++ tldr/mariadb-install-db | 4 ++++ tldr/msgfmt | 4 ++++ tldr/msginit | 4 ++++ tldr/msgmerge | 6 ++++- tldr/o | 4 ++++ tldr/osx/date | 4 ++++ tldr/passwd | 4 ++++ tldr/picocom | 4 ++++ tldr/propelauth | 25 ++++++++++++++++++++ tldr/pwd | 6 ++++- tldr/readarray | 4 ++++ tldr/script | 4 ++++ tldr/snmpbulkget | 4 ++++ tldr/snmpdf | 4 ++++ tldr/snmpget | 4 ++++ tldr/snmpgetnext | 4 ++++ tldr/snmpnetstat | 4 ++++ tldr/snmpset | 4 ++++ tldr/snmpstatus | 4 ++++ tldr/snmptable | 4 ++++ tldr/snmptest | 4 ++++ tldr/snmpwalk | 4 ++++ tldr/stty | 4 ++++ tldr/ulimit | 4 ++++ tldr/virt-sysprep | 4 ++++ tldr/wait | 4 ++++ tldr/xgettext | 4 ++++ 91 files changed, 438 insertions(+), 37 deletions(-) create mode 100644 tldr/aws-s3-sync create mode 100644 tldr/busybox create mode 100644 tldr/propelauth diff --git a/tldr/at b/tldr/at index 6ef58991..37cbbf58 100644 --- a/tldr/at +++ b/tldr/at @@ -28,3 +28,11 @@ source: https://github.com/tldr-pages/tldr.git - Execute commands from a given file next Tuesday: `at -f {{path/to/file}} 9:30 PM Tue` + +- List all queued jobs for the current user (same as `atq`): + +`at -l` + +- View a specied job: + +`at -c {{job_number}}` diff --git a/tldr/aws-s3-sync b/tldr/aws-s3-sync new file mode 100644 index 00000000..c0a054ec --- /dev/null +++ b/tldr/aws-s3-sync @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# aws s3 sync + +> Recursively sync files and directories between your local system and an S3 bucket, or between S3 buckets. +> More information: . + +- Sync files and directories from local to a bucket: + +`aws s3 sync {{path/to/file_or_directory}} s3://{{bucket_target_name}}/{{path/to/remote_location}}` + +- Sync files and directories from a bucket to local: + +`aws s3 sync s3://{{bucket_source_name}}/{{path/to/remote_location}} {{path/to/file_or_directory}}` + +- Sync objects between two buckets: + +`aws s3 sync s3://{{bucket_source_name}}/{{path/to/remote_location}} s3://{{bucket_target_name}}/{{path/to/remote_location}}` + +- Sync local files to S3 while excluding specific files or directories: + +`aws s3 sync {{path/to/file_or_directory}} s3://{{bucket_target_name}}/{{path/to/remote_location}} --exclude {{path/to/file}} --exclude {{path/to/directory}}/*` + +- Sync objects between buckets and delete destination files not in source: + +`aws s3 sync s3://{{bucket_source_name}}/{{path/to/remote_location}} s3://{{bucket_target_name}}/{{path/to/remote_location}} --delete` + +- Sync to S3 with advanced options (set ACL and storage class): + +`aws s3 sync {{path/to/local_directory}} s3://{{bucket_name}}/{{path/to/remote_location}} --acl {{private|public-read}} --storage-class {{STANDARD_IA|GLACIER}}` + +- Sync files to S3 and skip unchanged ones (compare size and modification time): + +`aws s3 sync {{path/to/file_or_directory}} s3://{{bucket_name}}/{{path/to/remote_location}} --size-only` + +- Display help: + +`aws s3 sync help` diff --git a/tldr/browsh b/tldr/browsh index 15096920..b291b533 100644 --- a/tldr/browsh +++ b/tldr/browsh @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit browsh: `` + +- Display help: + +`browsh {{[-h|--help]}}` diff --git a/tldr/btop b/tldr/btop index 2e593c46..635dd37c 100644 --- a/tldr/btop +++ b/tldr/btop @@ -32,3 +32,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit `btop`: `` + +- Display help: + +`btop {{[-h|--help]}}` diff --git a/tldr/busybox b/tldr/busybox new file mode 100644 index 00000000..7241eed4 --- /dev/null +++ b/tldr/busybox @@ -0,0 +1,19 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# busybox + +> A collection of small system utilities in a single executable. +> Executing `busybox` via a symlink is equivalent to running `busybox symlink_name`. +> Linux distributions that use BusyBox will usually provide symlinks for all programs. +> More information: . + +- Execute a BusyBox function: + +`busybox {{ls|rm|mkdir|cat|...}} {{args}}` + +- Display help and a list of functions: + +`busybox --help` diff --git a/tldr/carbonyl b/tldr/carbonyl index 2c9221bb..98fad56a 100644 --- a/tldr/carbonyl +++ b/tldr/carbonyl @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit carbonyl: `` + +- Display help: + +`carbonyl {{[-h|--help]}}` diff --git a/tldr/case b/tldr/case index 07ef0d01..8d71728f 100644 --- a/tldr/case +++ b/tldr/case @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Continue to the next pattern's commands without checking the pattern: `case {{$ANIMAL}} in {{cat}}) echo "It's a cat" ;& {{dog}}) echo "It's either a dog or cat fell through" ;& *) echo "Fallback" ;; esac` + +- Display help: + +`help case` diff --git a/tldr/docker-system b/tldr/docker-system index fc913f37..71dac095 100644 --- a/tldr/docker-system +++ b/tldr/docker-system @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `docker system df --verbose` -- Remove unused data: +- Remove unused data (append `--volumes` to remove unused volumes as well): `docker system prune` diff --git a/tldr/function b/tldr/function index f376f9c9..a9e34ada 100644 --- a/tldr/function +++ b/tldr/function @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a function named `func_name`: `func_name` + +- Display help: + +`help function` diff --git a/tldr/gettext b/tldr/gettext index 742b3f50..d6118dfc 100644 --- a/tldr/gettext +++ b/tldr/gettext @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Get the translation of a string or output a default string if it doesn't exist: `LANGUAGE={{locale}} gettext {{msgid}} {{default_value}}` + +- Display help: + +`gettext {{[-h|--help]}}` diff --git a/tldr/git-init b/tldr/git-init index 55a7ecdd..7785f5f0 100644 --- a/tldr/git-init +++ b/tldr/git-init @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a repository with the specified name for the initial branch: -`git init --initial-branch={{branch_name}}` +`git init {{[-b|--initial-branch]}} {{branch_name}}` - Initialize a repository using SHA256 for object hashes (requires Git version 2.29+): -`git init --object-format={{sha256}}` +`git init --object-format {{sha256}}` - Initialize a barebones repository, suitable for use as a remote over SSH: diff --git a/tldr/hash b/tldr/hash index 758eaeaf..0b75c0d6 100644 --- a/tldr/hash +++ b/tldr/hash @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Print the full path of `command`: `hash -t {{command}}` + +- Display help: + +`hash --help` diff --git a/tldr/iperf b/tldr/iperf index 9d41a796..543035a3 100644 --- a/tldr/iperf +++ b/tldr/iperf @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Run on server: -`iperf -s` +`iperf {{[-s|--server]}}` - Run on server using UDP mode and set server port to listen on 5001: -`iperf -u -s -p {{5001}}` +`iperf {{[-u|--udp]}} {{[-s|--server]}} {{[-p|--port]}} {{5001}}` - Run on client: -`iperf -c {{server_address}}` +`iperf {{[-c|--client]}} {{server_address}}` - Run on client every 2 seconds: -`iperf -c {{server_address}} -i {{2}}` +`iperf {{[-c|--client]}} {{server_address}} {{[-i|--interval]}} {{2}}` - Run on client with 5 parallel threads: -`iperf -c {{server_address}} -P {{5}}` +`iperf {{[-c|--client]}} {{server_address}} {{[-P|--parallel]}} {{5}}` - Run on client using UDP mode: -`iperf -u -c {{server_address}} -p {{5001}}` +`iperf {{[-u|--udp]}} {{[-c|--client]}} {{server_address}} {{[-p|--port]}} {{5001}}` diff --git a/tldr/iperf3 b/tldr/iperf3 index 851fb8e4..2350d7f6 100644 --- a/tldr/iperf3 +++ b/tldr/iperf3 @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run iperf3 as a server: -`iperf3 -s` +`iperf3 {{[-s|--server]}}` - Run an iperf3 server on a specific port: -`iperf3 -s -p {{port}}` +`iperf3 {{[-s|--server]}} {{[-p|--port]}} {{port}}` - Start bandwidth test: -`iperf3 -c {{server}}` +`iperf3 {{[-c|--client]}} {{server}}` - Run iperf3 in multiple parallel streams: -`iperf3 -c {{server}} -P {{streams}}` +`iperf3 {{[-c|--client]}} {{server}} {{[-P|--parallel]}} {{streams}}` - Reverse direction of the test. Server sends data to the client: -`iperf3 -c {{server}} -R` +`iperf3 {{[-c|--client]}} {{server}} {{[-R|--reverse]}}` diff --git a/tldr/linux/apachectl b/tldr/linux/apachectl index 94bb76d7..1ff54ef1 100644 --- a/tldr/linux/apachectl +++ b/tldr/linux/apachectl @@ -35,3 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Print full Apache configuration: `apachectl -S` + +- Display help: + +`apachectl -h` diff --git a/tldr/linux/aurpublish b/tldr/linux/aurpublish index 8b89306b..d4aa6c53 100644 --- a/tldr/linux/aurpublish +++ b/tldr/linux/aurpublish @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Add githooks to the current repository: `aurpublish setup` + +- Display help: + +`aurpublish {{[-h|--help]}}` diff --git a/tldr/linux/avahi-browse b/tldr/linux/avahi-browse index 4c886ca5..9a8486e5 100644 --- a/tldr/linux/avahi-browse +++ b/tldr/linux/avahi-browse @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - List services available on the local network along with their addresses and ports, ignoring ones on the local machine: -`avahi-browse --all --resolve --ignore-local` +`avahi-browse {{[-a|--all]}} {{[-r|--resolve]}} {{[-l|--ignore-local]}}` - Quickly list services in the local network in SSV format for scripts: -`avahi-browse --all --terminate --parsable` +`avahi-browse {{[-a|--all]}} {{[-t|--terminate]}} {{[-p|--parsable]}}` - List domains in the neighbourhood: -`avahi-browse --browse-domains` +`avahi-browse {{[-D|--browse-domains]}}` - Limit the search to a particular domain: -`avahi-browse --all --domain={{domain}}` +`avahi-browse {{[-a|--all]}} --domain={{domain}}` diff --git a/tldr/linux/avahi-resolve b/tldr/linux/avahi-resolve index 1cdf39c2..d3a4740e 100644 --- a/tldr/linux/avahi-resolve +++ b/tldr/linux/avahi-resolve @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Resolve a local service to its IPv4: -`avahi-resolve -4 --name {{service.local}}` +`avahi-resolve -4 {{[-n|--name]}} {{service.local}}` - Resolve an IP to a hostname, verbosely: -`avahi-resolve --verbose --address {{IP}}` +`avahi-resolve {{[-v|--verbose]}} {{[-a|--address]}} {{IP}}` diff --git a/tldr/linux/bridge b/tldr/linux/bridge index 7c3351de..a3971dd8 100644 --- a/tldr/linux/bridge +++ b/tldr/linux/bridge @@ -27,3 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Watch for changes in bridge interfaces: `bridge {{[mo|monitor]}}` + +- Display help: + +`bridge {{[h|help]}}` diff --git a/tldr/linux/chage b/tldr/linux/chage index 9d8b43bb..8a7f4bf2 100644 --- a/tldr/linux/chage +++ b/tldr/linux/chage @@ -10,20 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - List password information for the user: -`chage --list {{username}}` +`chage {{[-l|--list]]} {{username}}` - Enable password expiration in 10 days: -`sudo chage --maxdays {{10}} {{username}}` +`sudo chage {{[-M|--maxdays]}} {{10}} {{username}}` - Disable password expiration: -`sudo chage --maxdays {{-1}} {{username}}` +`sudo chage {{[-M|--maxdays]}} {{-1}} {{username}}` - Set account expiration date: -`sudo chage --expiredate {{YYYY-MM-DD}} {{username}}` +`sudo chage {{[-E|--expiredate]}} {{YYYY-MM-DD}} {{username}}` - Force user to change password on next log in: -`sudo chage --lastday {{0}} {{username}}` +`sudo chage {{[-d|--lastday]}} {{0}} {{username}}` + +- Re-enable an account: + +`sudo chage {{[-E|--expiredate]}} -1 {{username}}` diff --git a/tldr/linux/cu b/tldr/linux/cu index 2f786719..09043b86 100644 --- a/tldr/linux/cu +++ b/tldr/linux/cu @@ -27,3 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit the `cu` session when in connection: `<~><.>` + +- Display help: + +`cu --help` diff --git a/tldr/linux/dialog b/tldr/linux/dialog index 5b6f1549..6c417f9f 100644 --- a/tldr/linux/dialog +++ b/tldr/linux/dialog @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Prompt the user for a yes/no question: `dialog --yesno "{{Continue?}}" {{7}} {{40}}` + +- Display help: + +`dialog` diff --git a/tldr/linux/fadvise b/tldr/linux/fadvise index ef9cbe25..f93948e3 100644 --- a/tldr/linux/fadvise +++ b/tldr/linux/fadvise @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`fadvise --help` +`fadvise {{[-h|--help]}}` diff --git a/tldr/linux/fincore b/tldr/linux/fincore index 043fad04..21dd26e8 100644 --- a/tldr/linux/fincore +++ b/tldr/linux/fincore @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Display all possible data columns: `fincore --output-all {{path/to/file}}` + +- Display help: + +`fincore {{[-h|--help]}}` diff --git a/tldr/linux/fluidsynth b/tldr/linux/fluidsynth index cfef6f68..49419cca 100644 --- a/tldr/linux/fluidsynth +++ b/tldr/linux/fluidsynth @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Specify the audio driver: `fluidsynth {{[-a|--audio-driver]}} {{pipewire|pulseaudio}} {{path/to/soundfont.sf2}} {{path/to/file.midi}}` + +- Display help: + +`fluidsynth {{[-h|--help]}}` diff --git a/tldr/linux/gtk-launch b/tldr/linux/gtk-launch index 9ae3f013..af00ed25 100644 --- a/tldr/linux/gtk-launch +++ b/tldr/linux/gtk-launch @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Launch an application: `gtk-launch {{Application_name}}` + +- Display help: + +`gtk-launch {{[-h|--help]}}` diff --git a/tldr/linux/ifstatus b/tldr/linux/ifstatus index 501db655..9b4c5ca3 100644 --- a/tldr/linux/ifstatus +++ b/tldr/linux/ifstatus @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Display interface status: `ifstatus {{interface_name}}` + +- Display help: + +`ifstatus` diff --git a/tldr/linux/informant b/tldr/linux/informant index 74c52739..4ddff996 100644 --- a/tldr/linux/informant +++ b/tldr/linux/informant @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`informant --help` +`informant {{[-h|--help]}}` diff --git a/tldr/linux/ip-maddress b/tldr/linux/ip-maddress index 4302f612..26e63463 100644 --- a/tldr/linux/ip-maddress +++ b/tldr/linux/ip-maddress @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Leave a static multicast group: `sudo ip {{[m|maddress]}} {{[d|delete]}} {{33:33:00:00:00:02}} dev {{eth0}}` + +- Display help: + +`ip {{[m|maddress]}} {{[h|help]}}` diff --git a/tldr/linux/iwinfo b/tldr/linux/iwinfo index 1e9df301..23f64571 100644 --- a/tldr/linux/iwinfo +++ b/tldr/linux/iwinfo @@ -31,3 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - List available transmit power levels for the interface: `iwinfo {{interface}} txpowerlist` + +- Display help: + +`iwinfo h` diff --git a/tldr/linux/kwallet-query b/tldr/linux/kwallet-query index e87ffb98..c0a9d198 100644 --- a/tldr/linux/kwallet-query +++ b/tldr/linux/kwallet-query @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - List all available folders: `kwallet-query {{kdewallet}} {{[-l|--list-entries]}} {{[-f|--folder]}} ""` + +- Display help: + +`kwallet-query {{[-h|--help]}}` diff --git a/tldr/linux/libinput b/tldr/linux/libinput index 4b34a5f0..fccd19fa 100644 --- a/tldr/linux/libinput +++ b/tldr/linux/libinput @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`libinput -h` +`libinput {{[-h|--help]}}` diff --git a/tldr/linux/loginctl b/tldr/linux/loginctl index b2b7aabd..4e5e052c 100644 --- a/tldr/linux/loginctl +++ b/tldr/linux/loginctl @@ -31,3 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Log a user out on all of their sessions: `loginctl terminate-user {{username}}` + +- Display help: + +`loginctl {{[-h|--help]}}` diff --git a/tldr/linux/logread b/tldr/linux/logread index 7ad82982..863d1849 100644 --- a/tldr/linux/logread +++ b/tldr/linux/logread @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Print log messages as they happen: `logread -f` + +- Display help: + +`logread -h` diff --git a/tldr/linux/lsfd b/tldr/linux/lsfd index 77f03baf..eb5362d1 100644 --- a/tldr/linux/lsfd +++ b/tldr/linux/lsfd @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - List open IPv4 or IPv6 sockets: `lsfd -i{{4|6}}` + +- Display help: + +`lsfd {{[-h|--help]}}` diff --git a/tldr/linux/lslogins b/tldr/linux/lslogins index ee0d7e9f..14fcda52 100644 --- a/tldr/linux/lslogins +++ b/tldr/linux/lslogins @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Display users belonging to a specific group: -`lslogins --groups={{groups}}` +`lslogins {{[-g|--groups]}} {{groups}}` - Display user accounts: -`lslogins --user-accs` +`lslogins {{[-u|--user-accs]}}` - Display last logins: -`lslogins --last` +`lslogins {{[-L|--last]}}` - Display system accounts: -`lslogins --system-accs` +`lslogins {{[-s|--system-accs]}}` - Display supplementary groups: -`lslogins --supp-groups` +`lslogins {{[-G|--supp-groups]}}` diff --git a/tldr/linux/lxc-attach b/tldr/linux/lxc-attach index 0c746a29..92b9ac6c 100644 --- a/tldr/linux/lxc-attach +++ b/tldr/linux/lxc-attach @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Attach to a container: `sudo lxc-attach {{container_name}}` + +- Display help: + +`lxc-attach {{[-?|--help]}}` diff --git a/tldr/linux/lxc-console b/tldr/linux/lxc-console index 4811eb88..0f210e68 100644 --- a/tldr/linux/lxc-console +++ b/tldr/linux/lxc-console @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit `lxc-console`: `` + +- Display help: + +`lxc-console {{[-?|--help]}}` diff --git a/tldr/linux/lxc-create b/tldr/linux/lxc-create index a960dc5e..9e362cff 100644 --- a/tldr/linux/lxc-create +++ b/tldr/linux/lxc-create @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a container passing options to a template: `sudo lxc-create {{[-n|--name]}} {{container_name}} {{[-t|--template]}} download -- {{[-d|--dist]}} {{distro-name}} {{[-r|--release]}} {{release-version}} {{[-a|--arch]}} {{arch}}` + +- Display help: + +`lxc-create {{[-?|--help]}}` diff --git a/tldr/linux/lxc-destroy b/tldr/linux/lxc-destroy index 5c487cd6..95c76322 100644 --- a/tldr/linux/lxc-destroy +++ b/tldr/linux/lxc-destroy @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Delete a container: `sudo lxc-destroy {{container_name}}` + +- Display help: + +`lxc-destroy {{[-?|--help]}}` diff --git a/tldr/linux/lxc-info b/tldr/linux/lxc-info index c38a4df8..f23a5df8 100644 --- a/tldr/linux/lxc-info +++ b/tldr/linux/lxc-info @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Query information from a container: `sudo lxc-info {{container_name}}` + +- Display help: + +`lxc-info {{[-?|--help]}}` diff --git a/tldr/linux/lxc-ls b/tldr/linux/lxc-ls index cc17b677..7e8e9c31 100644 --- a/tldr/linux/lxc-ls +++ b/tldr/linux/lxc-ls @@ -27,3 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - List containers in a fancy, column-based output: `sudo lxc-ls {{[-f|--fancy]}}` + +- Display help: + +`lxc-ls {{[-?|--help]}}` diff --git a/tldr/linux/lxc-start b/tldr/linux/lxc-start index 4c78911f..dd407538 100644 --- a/tldr/linux/lxc-start +++ b/tldr/linux/lxc-start @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit out of a foreground container (run this in a separate terminal): `sudo lxc-stop {{container_name}}` + +- Display help: + +`lxc-start {{[-?|--help]}}` diff --git a/tldr/linux/lxc-stop b/tldr/linux/lxc-stop index 707c6bc7..eb30cfbf 100644 --- a/tldr/linux/lxc-stop +++ b/tldr/linux/lxc-stop @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Stop a container: `sudo lxc-stop {{container_name}}` + +- Display help: + +`lxc-stop {{[-?|--help]}}` diff --git a/tldr/linux/minicom b/tldr/linux/minicom index 6ecd5f0d..2012c887 100644 --- a/tldr/linux/minicom +++ b/tldr/linux/minicom @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit minicom: `` + +- Display help: + +`minicom {{[-h|--help]}}` diff --git a/tldr/linux/nstat b/tldr/linux/nstat index 02d3aabc..ec5b15b0 100644 --- a/tldr/linux/nstat +++ b/tldr/linux/nstat @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - View all-time network statistics: `nstat {{[-a|--ignore]}}` + +- Display help: + +`nstat {{[-h|--help]}}` diff --git a/tldr/linux/parted b/tldr/linux/parted index f0cb90df..e836f0de 100644 --- a/tldr/linux/parted +++ b/tldr/linux/parted @@ -24,3 +24,7 @@ source: https://github.com/tldr-pages/tldr.git - Start interactive mode with the specified disk selected: `sudo parted {{/dev/sdX}}` + +- Display help: + +`parted {{[-h|--help]}}` diff --git a/tldr/linux/parted-interactive b/tldr/linux/parted-interactive index 3c0c140e..57f2d09a 100644 --- a/tldr/linux/parted-interactive +++ b/tldr/linux/parted-interactive @@ -32,3 +32,7 @@ source: https://github.com/tldr-pages/tldr.git - Remove a partition in interactive mode: `rm {{/dev/sdXN}}` + +- Display help: + +`?` diff --git a/tldr/linux/pg b/tldr/linux/pg index 7bed5cc8..67e21c47 100644 --- a/tldr/linux/pg +++ b/tldr/linux/pg @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - View a file: `pg {{path/to/file}}` + +- Display help: + +`pg {{[-h|--help]}}` diff --git a/tldr/linux/pw-cat b/tldr/linux/pw-cat index 06920149..94fbe950 100644 --- a/tldr/linux/pw-cat +++ b/tldr/linux/pw-cat @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Record a sample recording using a different sample rate: `pw-cat --record --rate {{6000}} {{path/to/file.wav}}` + +- Display help: + +`pw-cat {{[-h|--help]}}` diff --git a/tldr/linux/pw-reserve b/tldr/linux/pw-reserve index 7a38eecc..998ad292 100644 --- a/tldr/linux/pw-reserve +++ b/tldr/linux/pw-reserve @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Monitor a device instead of reserving it: `pw-reserve {{[-n|--name]}} {{audioN}} {{[-m|--monitor]}}` + +- Display help: + +`pw-reserve {{[-h|--help]}}` diff --git a/tldr/linux/pw-v4l2 b/tldr/linux/pw-v4l2 index 0793c30e..0d8c9e6c 100644 --- a/tldr/linux/pw-v4l2 +++ b/tldr/linux/pw-v4l2 @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a program: `pw-v4l2 {{program}}` + +- Display help: + +`pw-v4l2 -h` diff --git a/tldr/linux/qmake b/tldr/linux/qmake index 97efe9d0..69218c8c 100644 --- a/tldr/linux/qmake +++ b/tldr/linux/qmake @@ -27,3 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Enable debug mode: `qmake -d` + +- Display help: + +`qmake -help` diff --git a/tldr/linux/reflector b/tldr/linux/reflector index ffc470e0..5f52ea86 100644 --- a/tldr/linux/reflector +++ b/tldr/linux/reflector @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Use a configuration file to fetch mirrors: `sudo reflector @{{/etc/xdg/reflector/reflector.conf}}` + +- Display help: + +`reflector {{[-h|--help]}}` diff --git a/tldr/linux/systemd-ask-password b/tldr/linux/systemd-ask-password index 40f29ac0..f1082267 100644 --- a/tldr/linux/systemd-ask-password +++ b/tldr/linux/systemd-ask-password @@ -35,3 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Pass the asked password to another program: `systemd-ask-password | {{command}}` + +- Display help: + +`systemd-ask-password {{[-h|--help]}}` diff --git a/tldr/linux/ubuntu-drivers b/tldr/linux/ubuntu-drivers index 17007629..cd7063f7 100644 --- a/tldr/linux/ubuntu-drivers +++ b/tldr/linux/ubuntu-drivers @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Install drivers for detected hardware: `sudo ubuntu-drivers install` + +- Display help: + +`ubuntu-drivers` diff --git a/tldr/linux/ubus b/tldr/linux/ubus index 31a7605f..b1268143 100644 --- a/tldr/linux/ubus +++ b/tldr/linux/ubus @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Listen to events: `ubus subscribe {{event_name}}` + +- Display help: + +`ubus` diff --git a/tldr/linux/uci b/tldr/linux/uci index d3297e4d..3ed91b3c 100644 --- a/tldr/linux/uci +++ b/tldr/linux/uci @@ -35,3 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Discard uncommitted changes: `uci revert {{config}}` + +- Display help: + +`uci` diff --git a/tldr/linux/usermod b/tldr/linux/usermod index 7e38e067..8fd71a83 100644 --- a/tldr/linux/usermod +++ b/tldr/linux/usermod @@ -23,8 +23,16 @@ source: https://github.com/tldr-pages/tldr.git - Add a user to supplementary groups (mind the lack of whitespace): -`sudo usermod {{[-a|--append]}} {{[-G|--groups]}} {{group1,group2,...}} {{username}}` +`sudo usermod {{[-aG|--append --groups]}} {{group1,group2,...}} {{username}}` - Change a user home directory: `sudo usermod {{[-m|--move-home]}} {{[-d|--home]}} {{path/to/new_home}} {{username}}` + +- Lock an account: + +`sudo usermod {{[-L|--lock]}} {{username}}` + +- Unlock an account: + +`sudo usermod {{[-U|--unlock]}} {{username}}` diff --git a/tldr/linux/waypipe b/tldr/linux/waypipe index 75cbd46f..e2e0710f 100644 --- a/tldr/linux/waypipe +++ b/tldr/linux/waypipe @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Skip testing for Vulkan support: `waypipe --test-skip-vulkan ssh {{user}}@{{server}} {{program}}` + +- Display help: + +`waypipe {{[-h|--help]}}` diff --git a/tldr/local b/tldr/local index b8af091a..8381f156 100644 --- a/tldr/local +++ b/tldr/local @@ -28,3 +28,7 @@ source: https://github.com/tldr-pages/tldr.git - Declare a readonly variable with the specified value: `local -r {{variable}}="{{value}}"` + +- Display help: + +`local --help` diff --git a/tldr/ls b/tldr/ls index 4de90a71..6bb785ad 100644 --- a/tldr/ls +++ b/tldr/ls @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - List files in [l]ong format, sorted by [S]ize (descending) recursively: -`ls {{-lSR|-lS --recursive}}` +`ls {{[-lSR|-lS --recursive]}}` - List files in [l]ong format, sorted by [t]ime the file was modified and in reverse order (oldest first): diff --git a/tldr/magick-mogrify b/tldr/magick-mogrify index 6b5211b5..82c96729 100644 --- a/tldr/magick-mogrify +++ b/tldr/magick-mogrify @@ -33,3 +33,7 @@ source: https://github.com/tldr-pages/tldr.git - Reduce file sizes of all GIF images in the current directory by reducing quality: `magick mogrify -layers 'optimize' -fuzz {{7%}} {{*.gif}}` + +- Display help: + +`magick mogrify -help` diff --git a/tldr/mail b/tldr/mail index 3c3b3ae5..32c39dde 100644 --- a/tldr/mail +++ b/tldr/mail @@ -24,3 +24,7 @@ source: https://github.com/tldr-pages/tldr.git - Send a `tar.gz` file as an attachment: `tar cvzf - {{path/to/directory1 path/to/directory2}} | uuencode {{data.tar.gz}} | mail --subject "{{subject_line}}" {{to_user@example.com}}` + +- Display help: + +`mail {{[-h|--help]}}` diff --git a/tldr/mariadb-install-db b/tldr/mariadb-install-db index a56062a7..3509fd33 100644 --- a/tldr/mariadb-install-db +++ b/tldr/mariadb-install-db @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a database: `sudo mariadb-install-db --user {{user}} --basedir {{/usr}} --datadir {{/var/lib/mysql}}` + +- Display help: + +`mariadb-install-db --help` diff --git a/tldr/msgfmt b/tldr/msgfmt index 6c9fa896..cd30a6fe 100644 --- a/tldr/msgfmt +++ b/tldr/msgfmt @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Convert a `.po` file to a `.mo` file: `msgfmt {{path/to/file.po}} {{[-o|--output-file]}} {{path/to/file.mo}}` + +- Display help: + +`msgfmt {{[-h|--help]}}` diff --git a/tldr/msginit b/tldr/msginit index 6a315fb3..59e746ba 100644 --- a/tldr/msginit +++ b/tldr/msginit @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Define locale to generate from a specific template: `msginit {{[-l|--locale]}} {{locale}} {{[-i|--input]}} {{path/to/messages.pot}}` + +- Display help: + +`msginit {{[-h|--help]}}` diff --git a/tldr/msgmerge b/tldr/msgmerge index 6cb5d30d..f7ac51b4 100644 --- a/tldr/msgmerge +++ b/tldr/msgmerge @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# Exclamation mark +# msgmerge > Update an existing translation file from a new template. > More information: . @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Update a translation file: `msgmerge {{[-U|--update]}} {{path/to/file.po}} {{path/to/messages.pot}}` + +- Display help: + +`msgmerge {{[-h|--help]}}` diff --git a/tldr/o b/tldr/o index 366e4c64..a4c65c50 100644 --- a/tldr/o +++ b/tldr/o @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Quit Orbiton: `` + +- Display help: + +`o {{[-h|--help]}}` diff --git a/tldr/osx/date b/tldr/osx/date index 1674d900..8fb0708c 100644 --- a/tldr/osx/date +++ b/tldr/osx/date @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Display a specific date (represented as a Unix timestamp) using the default format: `date -r {{1473305798}}` + +- Display a date relative to the current date using the default format: + +`date -v {{+1d}} -v {{-20m}}` diff --git a/tldr/passwd b/tldr/passwd index 4376b528..00be2314 100644 --- a/tldr/passwd +++ b/tldr/passwd @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Make the password of the account blank (it will set the named account passwordless): `passwd {{[-d|--delete]}}` + +- Set password programmatically (ideal for install scripts): + +`yes {{password}} | passwd` diff --git a/tldr/picocom b/tldr/picocom index 0b31f628..a61df584 100644 --- a/tldr/picocom +++ b/tldr/picocom @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Exit picocom: `` + +- Display help: + +`picocom {{[-h|--help]}}` diff --git a/tldr/propelauth b/tldr/propelauth new file mode 100644 index 00000000..6a174f3f --- /dev/null +++ b/tldr/propelauth @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# propelauth + +> Set up PropelAuth authentication as quickly and easily as possible. +> More information: . + +- Login to PropelAuth using an API Key generated from : + +`propelauth login` + +- Set the default PropelAuth Project for the CLI. If no default project is set, the system will prompt for selecting a Project each time certain commands are run: + +`propelauth set-default-project` + +- Install PropelAuth authentication in an application. If no directory is provided, the current directory is used: + +`propelauth setup {{[-f|--framework]}} {{path/to/directory}}` + +- Log the CLI out of PropelAuth: + +`propelauth logout` diff --git a/tldr/pwd b/tldr/pwd index 6d413247..a4af3497 100644 --- a/tldr/pwd +++ b/tldr/pwd @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pwd -> Print name of current/working directory. +> Print the name of current/working directory. > More information: . - Print the current directory: @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Print the current directory, and resolve all symlinks (i.e. show the "physical" path): `pwd {{[-P|--physical]}}` + +- Display help: + +`pwd --help` diff --git a/tldr/readarray b/tldr/readarray index a2f6bfae..a039f653 100644 --- a/tldr/readarray +++ b/tldr/readarray @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Copy at most the specified number of lines: `readarray -n {{N}} {{array_name}} < {{path/to/file.txt}}` + +- Display help: + +`help mapfile` diff --git a/tldr/script b/tldr/script index 5aa219af..791ed294 100644 --- a/tldr/script +++ b/tldr/script @@ -35,3 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Execute quietly without start and done messages: `script {{[-q|--quiet]}} {{logfile.log}}` + +- Display help: + +`script {{[-h|--help]}}` diff --git a/tldr/snmpbulkget b/tldr/snmpbulkget index 276aed2a..010351b6 100644 --- a/tldr/snmpbulkget +++ b/tldr/snmpbulkget @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Display the full Object Identifier (OID) path: `snmpbulkget -v {{version}} -c {{community}} -O f {{ip}} {{oid}}` + +- Display help: + +`snmpbulkget {{[-h|--help]}}` diff --git a/tldr/snmpdf b/tldr/snmpdf index 32ce3334..b9b13434 100644 --- a/tldr/snmpdf +++ b/tldr/snmpdf @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Fetch the disk space usage: `snmpdf -v {{version}} -c {{community}} {{ip}}` + +- Display help: + +`snmpdf {{[-h|--help]}}` diff --git a/tldr/snmpget b/tldr/snmpget index cf678a68..63331f6e 100644 --- a/tldr/snmpget +++ b/tldr/snmpget @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Display the full Object Identifier (OID) path: `snmpget -v {{version}} -c {{community}} -O f {{ip}} {{oid}}` + +- Display help: + +`snmpget {{[-h|--help]}}` diff --git a/tldr/snmpgetnext b/tldr/snmpgetnext index dd78de81..631ea721 100644 --- a/tldr/snmpgetnext +++ b/tldr/snmpgetnext @@ -15,3 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Display the full Object Identifier (OID) path: `snmpgetnext -v {{version}} -c {{community}} -O f {{ip}} {{oid}}` + +- Display help: + +`snmpgetnext {{[-h|--help]}}` diff --git a/tldr/snmpnetstat b/tldr/snmpnetstat index 2c216e0a..9fac59f2 100644 --- a/tldr/snmpnetstat +++ b/tldr/snmpnetstat @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Fetch the networking status: `snmpnetstat -v {{version}} -c {{community}} {{ip}}` + +- Display help: + +`snmpnetstat {{[-h|--help]}}` diff --git a/tldr/snmpset b/tldr/snmpset index edcda218..f010aecf 100644 --- a/tldr/snmpset +++ b/tldr/snmpset @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a value: `snmpset -v {{version}} -c {{community}} {{ip}} {{oid}} {{value_type}} {{value}}` + +- Display help: + +`snmpset {{[-h|--help]}}` diff --git a/tldr/snmpstatus b/tldr/snmpstatus index 9fb5ce00..f02568bf 100644 --- a/tldr/snmpstatus +++ b/tldr/snmpstatus @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Fetch the values: `snmpstatus -v {{version}} -c {{community}} {{ip}}` + +- Display help: + +`snmpstatus {{[-h|--help]}}` diff --git a/tldr/snmptable b/tldr/snmptable index 812ce76c..46d5ce3e 100644 --- a/tldr/snmptable +++ b/tldr/snmptable @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Fetch data: `snmptable -v {{version}} -c {{community}} {{ip}} {{oid}}` + +- Display help: + +`snmptable {{[-h|--help]}}` diff --git a/tldr/snmptest b/tldr/snmptest index 2e9d2643..e912f499 100644 --- a/tldr/snmptest +++ b/tldr/snmptest @@ -11,3 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Start the prompt: `snmptest -v {{version}} -c {{community}} {{ip}}` + +- Display help: + +`snmptest {{[-h|--help]}}` diff --git a/tldr/snmpwalk b/tldr/snmpwalk index 3df5f8ac..7af53971 100644 --- a/tldr/snmpwalk +++ b/tldr/snmpwalk @@ -27,3 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Query system information on a remote host by OID using SNMPv3 without authentication or encryption: `snmpwalk -v 3 -l {{noAuthNoPriv}} -u {{username}} {{ip}} {{oid}}` + +- Display help: + +`snmpwalk {{[-h|--help]}}` diff --git a/tldr/stty b/tldr/stty index 7685388b..2d7f4c63 100644 --- a/tldr/stty +++ b/tldr/stty @@ -31,3 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Turn character echoing off or on: `stty {{-echo|echo}}` + +- Display help: + +`stty --help` diff --git a/tldr/ulimit b/tldr/ulimit index 8797fd3f..94c43867 100644 --- a/tldr/ulimit +++ b/tldr/ulimit @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Set max per-user process limit: `ulimit -u 30` + +- Display help: + +`help ulimit` diff --git a/tldr/virt-sysprep b/tldr/virt-sysprep index 2d22e0ff..f88a5e5b 100644 --- a/tldr/virt-sysprep +++ b/tldr/virt-sysprep @@ -27,3 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate a new `/etc/machine-id` file and enable customizations to be able to change the host name to avoid network conflicts: `sudo virt-sysprep --domain {{vm_name}} --enable {{customizations}} --hostname {{host_name}} --operation {{machine-id}}` + +- Display help: + +`virt-sysprep {{[-he|--help]}}` diff --git a/tldr/wait b/tldr/wait index e13b6cb3..bee5f0b9 100644 --- a/tldr/wait +++ b/tldr/wait @@ -19,3 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Wait for a job to finish: `wait %{{N}}` + +- Display help: + +`wait --help` diff --git a/tldr/xgettext b/tldr/xgettext index 0b6cd9b1..fb018f23 100644 --- a/tldr/xgettext +++ b/tldr/xgettext @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Don't add a header containing metadata to the output file: `xgettext --omit-header {{path/to/input_file}}` + +- Display help: + +`xgettext {{[-h|--help]}}`