diff --git a/tldr/linux/libuser-lid b/tldr/linux/libuser-lid index b2bdf4ea..1f791a19 100644 --- a/tldr/linux/libuser-lid +++ b/tldr/linux/libuser-lid @@ -5,14 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # libuser-lid -> Display a user's groups or a group's users. -> On Fedora and Arch Linux, this program is installed as `lid`. -> More information: . +> This command is an alias of `lid`. -- List primary and secondary groups of a specific user: +- View documentation for the original command: -`sudo lid {{username}}` - -- List users of a specific group: - -`sudo lid --group {{name}}` +`tldr lid.libuser` diff --git a/tldr/linux/lid b/tldr/linux/lid index fcb1e4b3..669474fa 100644 --- a/tldr/linux/lid +++ b/tldr/linux/lid @@ -5,11 +5,12 @@ source: https://github.com/tldr-pages/tldr.git --- # lid -> Note: This page is currently a redirection stub. If you are familiar with this program, please open a pull request. -> Query ID database and report results. -> On Fedora and Arch Linux, the binary name `lid` is taken by another program - see `tldr libuser-lid`. -> More information: . +> `lid` can refer to multiple commands with the same name. -- View documentation for `libuser-lid`: +- View documentation for the `libuser` tool: -`tldr libuser-lid` +`tldr lid.libuser` + +- View documentation for the `idutils` tool: + +`tldr lid.idutils` diff --git a/tldr/linux/lid.libuser b/tldr/linux/lid.libuser new file mode 100644 index 00000000..e3cd0ad2 --- /dev/null +++ b/tldr/linux/lid.libuser @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lid + +> Display a user's groups or a group's users. +> More information: . + +- List primary and secondary groups of a specific user: + +`sudo lid {{username}}` + +- List users of a specific group: + +`sudo lid --group {{name}}` diff --git a/tldr/linux/lxc-top b/tldr/linux/lxc-top new file mode 100644 index 00000000..b8dc0432 --- /dev/null +++ b/tldr/linux/lxc-top @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# lxc-top + +> Display resource usage of LXC containers. +> More information: . + +- Start `lxc-top`: + +`lxc-top` + +- Adjust update interval: + +`lxc-top {{[-d|--delay]}} {{5}}` + +- Sort by [n]ame, [c]pu use, [b]lock I/O, [m]emory, or [k]ernel memory: + +`lxc-top {{[-s|--sort]}} {{n|c|b|m|k}}` diff --git a/tldr/linux/mount.ddi b/tldr/linux/mount.ddi index 368be56b..f4a99806 100644 --- a/tldr/linux/mount.ddi +++ b/tldr/linux/mount.ddi @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Mount Discoverable Disk Images. > See also: `systemd-dissect` for other commands relevant to DDIs. -> More information: . +> More information: . - Mount an OS image: diff --git a/tldr/linux/nmcli-agent b/tldr/linux/nmcli-agent index 3c8d1791..bd13787d 100644 --- a/tldr/linux/nmcli-agent +++ b/tldr/linux/nmcli-agent @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nmcli agent > Run `nmcli` as a NetworkManager secret agent or polkit agent. -> More information: . +> More information: . - Register `nmcli` as a secret agent and listen for secret requests: diff --git a/tldr/linux/nmcli-connection b/tldr/linux/nmcli-connection index 2d566668..5d6640a8 100644 --- a/tldr/linux/nmcli-connection +++ b/tldr/linux/nmcli-connection @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nmcli connection > Manage connections with NetworkManager. -> More information: . +> More information: . - List all NetworkManager connections (shows name, UUID, type and device): diff --git a/tldr/linux/nmcli-device b/tldr/linux/nmcli-device index b5f8dea7..1540b415 100644 --- a/tldr/linux/nmcli-device +++ b/tldr/linux/nmcli-device @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nmcli device > Manage network interfaces and establish new Wi-Fi connections using NetworkManager. -> More information: . +> More information: . - Print the statuses of all network interfaces: diff --git a/tldr/linux/nmcli-general b/tldr/linux/nmcli-general index 48e8c689..61125c55 100644 --- a/tldr/linux/nmcli-general +++ b/tldr/linux/nmcli-general @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nmcli general > Manage general settings of NetworkManager. -> More information: . +> More information: . - Show the general status of NetworkManager: diff --git a/tldr/linux/nmcli-monitor b/tldr/linux/nmcli-monitor index dc12ca56..8f269aa8 100644 --- a/tldr/linux/nmcli-monitor +++ b/tldr/linux/nmcli-monitor @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nmcli monitor > Monitor changes to the NetworkManager connection status. -> More information: . +> More information: . - Start monitoring NetworkManager changes: diff --git a/tldr/linux/nmcli-networking b/tldr/linux/nmcli-networking index 9ddb464e..d601b26b 100644 --- a/tldr/linux/nmcli-networking +++ b/tldr/linux/nmcli-networking @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nmcli networking > Manage the networking status of NetworkManager. -> More information: . +> More information: . - Show the networking status of NetworkManager: diff --git a/tldr/linux/nmcli-radio b/tldr/linux/nmcli-radio index 2a153838..6d7f442a 100644 --- a/tldr/linux/nmcli-radio +++ b/tldr/linux/nmcli-radio @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nmcli radio > Show the status of radio switches or enable/disable them using NetworkManager. -> More information: . +> More information: . - Show status of Wi-Fi: diff --git a/tldr/linux/partclone b/tldr/linux/partclone index 19082e02..b6b6cd9a 100644 --- a/tldr/linux/partclone +++ b/tldr/linux/partclone @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # partclone > Copy and restore partitions to and from an image while disregarding empty blocks. -> More information: . +> More information: . - Copy a partition into an image: diff --git a/tldr/linux/pct-clone b/tldr/linux/pct-clone index d143738b..943bb4fc 100644 --- a/tldr/linux/pct-clone +++ b/tldr/linux/pct-clone @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Clone a container with a custom name: -`pct clone {{template_id}} {{copy_id}} --hostname {{host_name}}` +`pct {{[cl|clone]}} {{template_id}} {{copy_id}} --hostname {{host_name}}` diff --git a/tldr/linux/pct-template b/tldr/linux/pct-template index 4a0b5f57..c19d1005 100644 --- a/tldr/linux/pct-template +++ b/tldr/linux/pct-template @@ -10,4 +10,4 @@ source: https://github.com/tldr-pages/tldr.git - Convert a container into a template: -`pct template {{100}}` +`pct {{[t|template]}} {{100}}` diff --git a/tldr/linux/pve-firewall b/tldr/linux/pve-firewall index 6ff853f4..1f060f09 100644 --- a/tldr/linux/pve-firewall +++ b/tldr/linux/pve-firewall @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Compile and print all firewall rules: -`pve-firewall compile` +`pve-firewall {{[c|compile]}}` - Show information about the local network: -`pve-firewall localnet` +`pve-firewall {{[l|localnet]}}` - Restart the Proxmox VE Firewall service: -`pve-firewall restart` +`pve-firewall {{[r|restart]}}` - Start the Proxmox VE Firewall service: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Simulate all firewall rules: -`pve-firewall simulate` +`pve-firewall {{[si|simulate]}}` - Show the status of Proxmox VE Firewall: diff --git a/tldr/linux/pveam b/tldr/linux/pveam index e60c87da..85ac0fd4 100644 --- a/tldr/linux/pveam +++ b/tldr/linux/pveam @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Update container template database: -`pveam update` +`pveam {{[u|update]}}` - List available templates: -`pveam available` +`pveam {{[a|available]}}` - Download a template: -`pveam download {{local}} {{template_name}}` +`pveam {{[d|download]}} {{local}} {{template_name}}` - List downloaded templates: -`pveam list {{local}}` +`pveam {{[l|list]}} {{local}}` diff --git a/tldr/linux/pvecm b/tldr/linux/pvecm index c8d0f4d6..90301b91 100644 --- a/tldr/linux/pvecm +++ b/tldr/linux/pvecm @@ -14,24 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Add a node to the cluster configuration (internal use): -`pvecm addnode {{node}}` +`pvecm {{[addn|addnode]}} {{node}}` - Display the version of the cluster join API available on this node: -`pvecm apiver` +`pvecm {{[ap|apiver]}}` - Generate new cluster configuration: -`pvecm create {{clustername}}` +`pvecm {{[c|create]}} {{clustername}}` - Remove a node from the cluster configuration: -`pvecm delnode {{node}}` +`pvecm {{[d|delnode]}} {{node}}` - Display the local view of the cluster nodes: -`pvecm nodes` +`pvecm {{[n|nodes]}}` - Display the local view of the cluster status: -`pvecm status` +`pvecm {{[s|status]}}` diff --git a/tldr/linux/pvesh b/tldr/linux/pvesh index 4bf2ccee..5a602931 100644 --- a/tldr/linux/pvesh +++ b/tldr/linux/pvesh @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - List available nodes: -`pvesh get /nodes` +`pvesh {{[g|get]}} /nodes` - Discover API paths: -`pvesh ls {{/}}` +`pvesh {{[l|ls]}} {{/}}` diff --git a/tldr/linux/pvesm b/tldr/linux/pvesm index 8df4c19c..f9c7a551 100644 --- a/tldr/linux/pvesm +++ b/tldr/linux/pvesm @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Get status for all datastores: -`pvesm status` +`pvesm {{[st|status]}}` - List storage contents: -`pvesm list {{storage_name}}` +`pvesm {{[l|list]}} {{storage_name}}` - Add a directory storage: -`pvesm add dir {{storage_name}} --path {{path/to/directory}}` +`pvesm add {{[d|dir]}} {{storage_name}} --path {{path/to/directory}}` - Remove a storage: -`pvesm remove {{storage_name}}` +`pvesm {{[r|remove]}} {{storage_name}}` diff --git a/tldr/linux/pveum b/tldr/linux/pveum index e5803369..94a8b658 100644 --- a/tldr/linux/pveum +++ b/tldr/linux/pveum @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - List users: -`pveum user list` +`pveum {{[u|user]}} {{[l|list]}}` - Add a user: -`pveum user add {{username}}@pve` +`pveum {{[u|user]}} {{[a|add]}} {{username}}@pve` - Delete a user: -`pveum user delete {{username}}@pve` +`pveum {{[u|user]}} {{[d|delete]}} {{username}}@pve` diff --git a/tldr/linux/qm-disk-rescan b/tldr/linux/qm-disk-rescan index 7abf9767..8978a09b 100644 --- a/tldr/linux/qm-disk-rescan +++ b/tldr/linux/qm-disk-rescan @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Rescan all storages and update disk sizes and unused disk images of a specific virtual machine: -`qm disk rescan {{vm_id}}` +`qm {{[di|disk]}} {{[resc|rescan]}} {{vm_id}}` - Perform a dry-run of rescan on a specific virtual machine and do not write any changes to configurations: -`qm disk rescan --dryrun {{true}} {{vm_id}}` +`qm {{[di|disk]}} {{[resc|rescan]}} --dryrun {{true}} {{vm_id}}` diff --git a/tldr/linux/qm-list b/tldr/linux/qm-list index 0238a052..86d20962 100644 --- a/tldr/linux/qm-list +++ b/tldr/linux/qm-list @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - List all virtual machines: -`qm list` +`qm {{[l|list]}}` - List all virtual machines with a full status about the ones which are currently running: -`qm list --full 1` +`qm {{[l|list]}} --full 1` diff --git a/tldr/linux/qm-terminal b/tldr/linux/qm-terminal index bfdb1409..9ba0ff9a 100644 --- a/tldr/linux/qm-terminal +++ b/tldr/linux/qm-terminal @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Attach to a terminal: -`qm terminal {{100}}` +`qm {{[ter|terminal]}} {{100}}` - Detach from a terminal: diff --git a/tldr/linux/repo-add b/tldr/linux/repo-add index 567ad696..141cb012 100644 --- a/tldr/linux/repo-add +++ b/tldr/linux/repo-add @@ -6,13 +6,18 @@ source: https://github.com/tldr-pages/tldr.git # repo-add > Package database maintenance utility which enables installation of said package via Pacman. +> See also: `repo-remove`. > More information: . - Create an empty repository: `repo-add {{path/to/database.db.tar.gz}}` -- Add all package binaries in the current directory and remove the old database file: +- Add packages to the repository: + +`repo-add {{path/to/database.db.tar.gz}} {{package1.pkg.tar.zst package2.pkg.tar.zst ...}}` + +- Add all package binaries in the current directory and remove any outdated package files: `repo-add {{[-R|--remove]}} {{path/to/database.db.tar.gz}} {{*.pkg.tar.zst}}` diff --git a/tldr/linux/repo-remove b/tldr/linux/repo-remove index de21c02b..b9710cc2 100644 --- a/tldr/linux/repo-remove +++ b/tldr/linux/repo-remove @@ -6,6 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # repo-remove > Package database maintenance utility which removes packages from a local repository. +> See also: `repo-add`. > More information: . - Remove a package from a local repository: diff --git a/tldr/linux/run0 b/tldr/linux/run0 index f091531c..cd0cf067 100644 --- a/tldr/linux/run0 +++ b/tldr/linux/run0 @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Elevate privileges interactively. > Similar to `sudo`, but it's not a SUID binary, authentication takes place via polkit, and commands are invoked from a `systemd` service. -> More information: . +> More information: . - Run a command as root: diff --git a/tldr/linux/systemctl-disable b/tldr/linux/systemctl-disable index 1a25b186..58d1f5e3 100644 --- a/tldr/linux/systemctl-disable +++ b/tldr/linux/systemctl-disable @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl disable > Disable systemd services. -> More information: . +> More information: . - Stop a service from running on boot: diff --git a/tldr/linux/systemctl-enable b/tldr/linux/systemctl-enable index b2e6b2ef..8f7ce889 100644 --- a/tldr/linux/systemctl-enable +++ b/tldr/linux/systemctl-enable @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemctl enable > Enable systemd services. -> More information: . +> More information: . - Enable a service to run on boot: diff --git a/tldr/linux/systemd-cgtop b/tldr/linux/systemd-cgtop index da8ee7cd..bd408f83 100644 --- a/tldr/linux/systemd-cgtop +++ b/tldr/linux/systemd-cgtop @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Change the sort order: -`systemd-cgtop {{[-i|--order]}} {{cpu|memory|path|tasks|io}}` +`systemd-cgtop --order {{cpu|memory|path|tasks|io}}` - Show the CPU usage by time instead of percentage: -`systemd-cgtop --cpu percentage` +`systemd-cgtop --cpu=percentage` - Change the update interval in seconds (or one of these time units: `ms`, `us`, `min`): diff --git a/tldr/linux/systemd-cryptsetup b/tldr/linux/systemd-cryptsetup index 0b3373b7..1023db57 100644 --- a/tldr/linux/systemd-cryptsetup +++ b/tldr/linux/systemd-cryptsetup @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Create or remove decrypted mappings of encrypted volumes. Equivalent of `cryptsetup open` and `cryptsetup close`. > Arguments to this command are written exactly like a line in `/etc/crypttab`. It's used by systemd to unlock devices on boot. > See also: `cryptsetup`. -> More information: . +> More information: . - Open a LUKS volume and create a decrypted mapping at `/dev/mapper/mapping_name`: diff --git a/tldr/linux/systemd-dissect b/tldr/linux/systemd-dissect index 3ef4d388..7b36b511 100644 --- a/tldr/linux/systemd-dissect +++ b/tldr/linux/systemd-dissect @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemd-dissect > Introspect and interact with file system OS disk images, specifically Discoverable Disk Images (DDIs). -> More information: . +> More information: . - Show general image information about the OS image: diff --git a/tldr/linux/systemd-nspawn b/tldr/linux/systemd-nspawn index 6adb3399..c7a421dd 100644 --- a/tldr/linux/systemd-nspawn +++ b/tldr/linux/systemd-nspawn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemd-nspawn > Spawn a command or OS in a lightweight container. -> More information: . +> More information: . - Run a command in a container: diff --git a/tldr/linux/systemd-socket-activate b/tldr/linux/systemd-socket-activate index 6430e434..d14b1261 100644 --- a/tldr/linux/systemd-socket-activate +++ b/tldr/linux/systemd-socket-activate @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemd-socket-activate > Socket activation for systemd services. -> More information: . +> More information: . - Activate a service when a specific socket is connected: diff --git a/tldr/linux/systemd-stdio-bridge b/tldr/linux/systemd-stdio-bridge index acf44118..43329238 100644 --- a/tldr/linux/systemd-stdio-bridge +++ b/tldr/linux/systemd-stdio-bridge @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Implement a proxy between `stdin`/`stdout` and a D-Bus. > Note: It expects to receive an open connection via `stdin`/`stdout` when started, and will create a new connection to the specified bus. -> More information: . +> More information: . - Forward `stdin`/`stdout` to the local system bus: diff --git a/tldr/linux/updatectl b/tldr/linux/updatectl index 09f382da..379bffd6 100644 --- a/tldr/linux/updatectl +++ b/tldr/linux/updatectl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # updatectl > System update utility. -> More information: . +> More information: . - Apply an update: diff --git a/tldr/php b/tldr/php index 4d16ea5d..6946c1cf 100644 --- a/tldr/php +++ b/tldr/php @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Start a PHP built-in web [S]erver in the current directory: -`php {{[-S|--server]}} {{host:port}}` +`php {{[-S|--server]}} {{host}}:{{port}}` - List installed PHP extensions: diff --git a/tldr/rmdir b/tldr/rmdir index 3a41554f..5e94276d 100644 --- a/tldr/rmdir +++ b/tldr/rmdir @@ -16,3 +16,7 @@ source: https://github.com/tldr-pages/tldr.git - Remove specific nested directories recursively: `rmdir {{[-p|--parents]}} {{path/to/directory1 path/to/directory2 ...}}` + +- Clean a directory of empty directories: + +`rmdir *` diff --git a/tldr/sr b/tldr/sr new file mode 100644 index 00000000..a1f0c5bb --- /dev/null +++ b/tldr/sr @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# sr + +> This command is an alias of `surfraw`. + +- View documentation for the original command: + +`tldr surfraw` diff --git a/tldr/surfraw b/tldr/surfraw index a35f0792..847310df 100644 --- a/tldr/surfraw +++ b/tldr/surfraw @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Open the elvi's results page for a specific search in the browser: -`surfraw {{elvi}} "{{search_terms}}"` +`surfraw {{elvi_name}} "{{search_terms}}"` - Display an elvi description and its specific options: -`surfraw {{elvi}} -local-help` +`surfraw {{elvi_name}} {{[-lh|-local-help]}}` - Search using an elvi with specific options and open the results page in the browser: -`surfraw {{elvi}} {{elvi_options}} "{{search_terms}}"` +`surfraw {{elvi_name}} {{elvi_options}} "{{search_terms}}"` - Display the URL to the elvi's results page for a specific search: -`surfraw -print {{elvi}} "{{search_terms}}"` +`surfraw -print {{elvi_name}} "{{search_terms}}"` - Search using the alias: -`sr {{elvi}} "{{search_terms}}"` +`sr {{elvi_name}} "{{search_terms}}"`