Linux man-pages

https://man7.org/linux/man-pages/
Admin
Linux man-pages is a comprehensive collection of manual pages documenting Linux kernel interfaces,...
Tokens:8,243,752
Snippets:61,664
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### ibacm quick start guide steps

Source: https://man7.org/linux/man-pages/man8/ibacm.8.html

Step-by-step instructions to install and verify the ibacm service. Requires libibverbs and libibumad, administrative privileges, and an IB stack with IPoIB configured. Includes commands to start ibacm, verify with ib_acme, and note that librdmacm automatically uses the service with fallback on failure.

```text
       1. Prerequisites: libibverbs and libibumad must be installed.  The
       IB stack should be running with IPoIB configured.  These steps
       assume that the user has administrative privileges.

       2. Install the IB ACM package.  This installs ibacm, ibacmp,
       ib_acme, and init.d scripts.

       3. Run 'ibacm' as administrator to start the ibacm daemon.

       4. Optionally, run 'ib_acme -d <dest_ip> -v' to verify that the
       ibacm service is running.

       5. Install librdmacm, using the build option --with-ib_acm if
       needed.  This build option is not needed with librdmacm 1.0.17 or
       newer.  The librdmacm will automatically use the ibacm service.
       On failures, the librdmacm will fall back to normal resolution.

       6. You can use ib_acme -P to gather performance statistics from
       the local ibacm daemon to see if the service is working correctly.
       Similarly, the command ib_acme -e could be used to enumerate all
       endpoints created by the local ibacm service.

```

--------------------------------

### dnf install examples

Source: https://man7.org/linux/man-pages/man8/yum-shell.8.html

Various examples of the dnf install command: installing by name, local file, specific version, latest version, provides, URL, module, and group.

```bash
dnf install tito
```

```bash
dnf install ~/Downloads/tito-0.6.2-1.fc22.noarch.rpm
```

```bash
dnf install tito-0.5.6-1.fc22
```

```bash
dnf --best install tito
```

```bash
dnf install vim
```

```bash
dnf install
https://kojipkgs.fedoraproject.org//packages/tito/0.6.0/1.fc22/noarch/tito-0.6.0-1.fc22.noarch.rpm
```

```bash
dnf install '@docker'
```

```bash
dnf install '@Web Server'
```

--------------------------------

### firecfg --guide example

Source: https://man7.org/linux/man-pages/man1/firecfg.1.html

Shows how to run the guided configuration for new users using the --guide option.

```bash
$ sudo firecfg --guide
```

--------------------------------

### flatpak install examples

Source: https://man7.org/linux/man-pages/man1/flatpak-install.1.html

Examples of installing applications with flatpak install, covering default remote, explicit remote and application ID, installation-specific commands, branch selection, and installation from a flatpakref file.

```shell
$ flatpak install gedit
```

```shell
$ flatpak install flathub org.gnome.gedit
```

```shell
$ flatpak --installation=default install flathub org.gnome.gedit
```

```shell
$ flatpak --user install flathub org.gnome.gedit//3.30
```

```shell
$ flatpak --user install
https://flathub.org/repo/appstream/org.gnome.gedit.flatpakref
```

```shell
$ flatpak --system install org.gnome.gedit.flatpakref
```

--------------------------------

### debuginfo-install EXAMPLES section

Source: https://man7.org/linux/man-pages/man1/debuginfo-install.1.html

The EXAMPLES section showing how to download and install all RPMs needed to debug the kernel RPM using the command 'debuginfo-install kernel'.

```text
       Download and install all the RPMs needed to debug the kernel RPM:
              **debuginfo-install **kernel
```

--------------------------------

### openvt examples: start shell, login shell, and command with options

Source: https://man7.org/linux/man-pages/man1/openvt.1.html

Three usage examples from the EXAMPLES section: start a shell on the next free VT with 'openvt bash', start a login shell with 'openvt -l bash', and run a command with options using the -- separator as in 'openvt -- ls -l'.

```text
_openvt bash_
```

```text
_openvt -l bash_
```

```text
_openvt -- ls -l_
```

--------------------------------

### Example: set, check, and clear bandwidth for mybrowser

Source: https://man7.org/linux/man-pages/man1/firejail.1.html

Example workflow showing how to start a sandbox with a network interface, set bandwidth limits, check status, and clear them.

```bash
$ firejail --name=mybrowser --net=eth0 firefox &
$ firejail --bandwidth=mybrowser set eth0 80 20
$ firejail --bandwidth=mybrowser status
$ firejail --bandwidth=mybrowser clear eth0
```

--------------------------------

### Examples of more -p option

Source: https://man7.org/linux/man-pages/man1/more.1p.html

Shows three examples of using the -p option to execute commands at the start of each file: -p G starts at the last screenful, -p 100 starts at line 100 (usually line 98 written first), and -p /100 starts at the first line containing the string "100".

```text
       _more_ **-p G **_file1 file2_
             Examine each file starting with its last screenful.

```

```text
       _more_ **-p **100 _file1 file2_
             Examine each file starting with line 100 in the current
             position (usually the third line, so line 98 would be the
             first line written).

```

```text
       _more_ **-p **/100 _file1 file2_
             Examine each file starting with the first line containing
             the string **"100" **in the current position

```

--------------------------------

### Example 5: Start screen as a user service

Source: https://man7.org/linux/man-pages/man1/systemd-run.1.html

Starts screen as a user scope unit and shows how to list screen sessions. Also shows how to enable lingering for the user.

```shell
$ systemd-run --scope --user screen
Running scope as unit run-r14b0047ab6df45bfb45e7786cc839e76.scope.

$ screen -ls
There is a screen on:
        492..laptop     (Detached)
1 Socket in /var/run/screen/S-fatima.
```

```shell
$ loginctl enable-linger
```

--------------------------------

### cups-x509 usage examples

Source: https://man7.org/linux/man-pages/man1/cups-x509.1.html

Shows example commands for creating a CSR, installing a certificate, running a test server, and testing a client connection with validation.

```text
       Create a certificate signing request for a 384-bit ECDSA
       certificate for "server.example.com":
            cups-x509 csr -t ecdsa-p384 server.example.com
       Install the certificate you get back from the CA for
       "server.example.com":
            cups-x509 install server.example.com server.example.com.crt
       Run a test server for "server.exmaple.com" on port 8080:
            cups-x509 server SERVER-NAME:8080
       Test a HTTPS client connection to "www.example.com" with
       validation:
            cups-x509 client --require-ca https://www.example.com/

```

--------------------------------

### Load example LLDP configuration file

Source: https://man7.org/linux/man-pages/man8/mausezahn.8.html

Shows the CLI command to load a prepared LLDP configuration file from a path. The file src/examples/mausezahn/example_lldp.conf contains commands to create a bogus LLDP packet. After loading, the packet appears in the packet list and can be activated with 'start slot <nr>'.

```text
mz# load /home/hh/tmp/example_lldp.conf
```

--------------------------------

### Example /etc/pam.d/login configuration using pam_unix.so

Source: https://man7.org/linux/man-pages/man8/pam_unix.8.html

Shows a typical PAM configuration for /etc/pam.d/login that uses pam_unix.so for authentication, account management, and session setup, and integrates pam_passwdqc.so for password strength checking before changing the password with pam_unix.so.

```pam
# Authenticate the user
auth       required   pam_unix.so
# Ensure user's account and password are still active
account    required   pam_unix.so
# Change the user's password, but at first check the strength
# with pam_passwdqc(8)
password   required   pam_passwdqc.so config=/etc/passwdqc.conf
password   required   pam_unix.so use_authtok nullok yescrypt
session    required   pam_unix.so
```

--------------------------------

### Simple Example: nginx.conf

Source: https://man7.org/linux/man-pages/man8/systemd-socket-proxyd.8.html

Nginx configuration for the simple proxy example.

```nginx
[...]
server {
    listen       unix:/run/nginx/socket;
    [...]
```

--------------------------------

### Interactive mode: show packet and start slot example

Source: https://man7.org/linux/man-pages/man8/mausezahn.8.html

Shows the output of 'show packet' before and after activating packet slot 2 with 'start slot 2'. The output includes packet details such as layers, protocol, size, state, device, delay, and count. Note the 'I' flag indicating an interval is specified for packet 2.

```text
mz# show packet
Packet layer flags: E=Ethernet, S=SNAP, Q=802.1Q, M=MPLS,
I/i=IP/delivery_off, U=UDP, T=TCP
PktID  PktName           Layers  Proto    Size  State
Device      Delay       Count/CntX
      1  sysARP_servic...  E-----  ARP        60  config     lo
100 msec        1/0 (100%)
      2  Test              E-Q-IT            125  config-i   eth0
15 usec       10/10 (0%)
      3  PKT0003           E-----  LLDP       36  config     eth0
30 sec        0/12 (0%)
      4  PKT0004           E---I-  IGMP       46  config     eth0
100 msec        0/0 (0%)
      5  sysBPDU           ES----  BPDU       29  active     eth0
2 sec        0/251 (0%)
5 packets defined, 1 active.
mz# start slot 2
Activate [2]
mz# show packet
Packet layer flags: E=Ethernet, S=SNAP, Q=802.1Q, M=MPLS,
I/i=IP/delivery_off, U=UDP, T=TCP
PktID  PktName           Layers  Proto    Size  State
Device      Delay       Count/CntX
      1  sysARP_servic...  E-----  ARP        60  config     lo
100 msec        1/0 (100%)
      2  Test              E-Q-IT            125  config+I   eth0
15 usec       10/0 (100%)
      3  PKT0003           E-----  LLDP       36  config     eth0
30 sec        0/12 (0%)
      4  PKT0004           E---I-  IGMP       46  config     eth0
100 msec        0/0 (0%)
      5  sysBPDU           ES----  BPDU       29  active     eth0
2 sec        0/256 (0%)
5 packets defined, 1 active.
```

--------------------------------

### Invoke systemd-sysinstall for fully automatic non-interactive OS installation

Source: https://man7.org/linux/man-pages/man8/systemd-sysinstall.service.8.html

Example command that installs the OS on the selected disk, erasing previous contents without confirmation, registers it in the firmware, and drops in the SSH key for the root user read from the my-ssh-key file in the current directory.

```shell
systemd-sysinstall \
        /dev/disk/by-id/nvme-Micron_MTFDKBA1T0TFH_214532D0CDA5 \
        --erase=yes \
        --confirm=no \
        --variables=yes \
        --load-credential=ssh.authorized_keys.root:my-ssh-key
```

--------------------------------

### WireGuard configuration file example

Source: https://man7.org/linux/man-pages/man8/wg.8.html

Example configuration file using INI-like syntax. Comments start with '#' and are ignored. Contains one [Interface] section and multiple [Peer] sections with keys like PrivateKey, ListenPort, PublicKey, Endpoint, and AllowedIPs.

```ini
[Interface]
PrivateKey = yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=
ListenPort = 51820

[Peer]
PublicKey = xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=
Endpoint = 192.95.5.67:1234
AllowedIPs = 10.192.122.3/32, 10.192.124.1/24

[Peer]
PublicKey = TrMvSoP4jYQlY6RIzBgbssQqY3vxI2Pi+y71lOWWXX0=
Endpoint = [2607:5300:60:6b0::c05f:543]:2468
AllowedIPs = 10.192.122.4/32, 192.168.0.0/16

[Peer]
PublicKey = gN65BkIKy1eCE9pP1wdc8ROUtkHLF2PfAqYdyYBz6EA=
Endpoint = test.wireguard.com:18981
AllowedIPs = 10.10.10.230/32
```

--------------------------------

### firejail --netfilter.print example

Source: https://man7.org/linux/man-pages/man1/firejail.1.html

Starts a sandbox named 'browser' with a netfilter and then prints the firewall installed in that sandbox using --netfilter.print.

```bash
$ firejail --name=browser --net=eth0 --netfilter firefox &
$ firejail --netfilter.print=browser
```

--------------------------------

### Simple Example: proxy-to-nginx.service

Source: https://man7.org/linux/man-pages/man8/systemd-socket-proxyd.8.html

Service configuration for the simple proxy example.

```ini
[Unit]
Requires=nginx.service
After=nginx.service
Requires=proxy-to-nginx.socket
After=proxy-to-nginx.socket

[Service]
Type=notify
ExecStart=/usr/lib/systemd/systemd-socket-proxyd /run/nginx/socket
PrivateTmp=yes
PrivateNetwork=yes
```

--------------------------------

### Simple Example: proxy-to-nginx.socket

Source: https://man7.org/linux/man-pages/man8/systemd-socket-proxyd.8.html

Socket configuration for the simple proxy example.

```ini
[Socket]
ListenStream=80

[Install]
WantedBy=sockets.target
```

--------------------------------

### firejail --netfilter6.print example

Source: https://man7.org/linux/man-pages/man1/firejail.1.html

Starts a sandbox named 'browser' with a netfilter and then prints the IPv6 firewall installed in that sandbox using --netfilter6.print.

```bash
$ firejail --name=browser --net=eth0 --netfilter firefox &
$ firejail --netfilter6.print=browser
```

--------------------------------

### flatpak preinstall example

Source: https://man7.org/linux/man-pages/man1/flatpak-preinstall.1.html

Run the flatpak preinstall command.

```console
$ flatpak preinstall
```

--------------------------------

### Display example configuration

Source: https://man7.org/linux/man-pages/man1/mariadbd-multi.1.html

Command to display a sample option file for setting up multiple MariaDB servers.

```shell
mariadbd-multi --example
```

--------------------------------

### Get installed libcurl version with curl-config --version

Source: https://man7.org/linux/man-pages/man1/curl-config.1.html

Shows how to get the installed libcurl version.

```shell
$ curl-config --version
```

--------------------------------

### Start mariadbd-safe from installation directory

Source: https://man7.org/linux/man-pages/man1/mariadbd-safe.1.html

Shows how to start mariadbd-safe from the MariaDB installation directory so it can find the server and databases.

```shell
cd mysql_installation_directory
bin/mariadbd-safe &
```

--------------------------------

### Example 1: Basic setup with Sequoia PGP

Source: https://man7.org/linux/man-pages/man1/rpmsign.1.html

Shows the contents to add to the user's rpm-config(5) file (typically ~/.config/rpm/macros) to configure RPM to sign packages with Sequoia PGP and a specific key fingerprint.

```text
   **Example 1. Basic setup**
       Configure RPM to sign packages with Sequoia PGP and a specific key
       by adding the following contents to the user's rpm-config(5) file
       (typically _~/.config/rpm/macros_):

           %_openpgp_sign sq
           %_openpgp_sign_id 7B36C3EE0CCE86EDBC3EFF2685B274E29F798E08

```

--------------------------------

### OPTIONS: -G option example

Source: https://man7.org/linux/man-pages/man8/ibcheckportwidth.8.html

The -G option uses a GUID address argument. The example shows a GUID value.

```text
"0x08f1040023"
```

--------------------------------

### Start a server and connect with mariadb client

Source: https://man7.org/linux/man-pages/man1/mysql-test-run.pl.1.html

Shows how to start a server with --start and connect to it using the mariadb client. The commands are run from the mariadb-test directory.

```shell
cd mariadb-test
./mariadb-test-run.pl --start alias &
../mariadb -S ./var/tmp/master.sock -h localhost -u root
```

--------------------------------

### Example $HOME/.perfconfig file

Source: https://man7.org/linux/man-pages/man1/perf-config.1.html

A full example of a $HOME/.perfconfig file with sections for colors, tui, buildid, annotate, help, ui, call-graph, and report.

```text
       # # This is the config file, and # a _#_ and _;_ character indicates a
       comment #

           [colors]
                   # Color variables
                   top = red, default
                   medium = green, default
                   normal = lightgray, default
                   selected = white, lightgray
                   jump_arrows = blue, default
                   addr = magenta, default
                   root = white, blue

           [tui]
                   # Defaults if linked with libslang
                   report = on
                   annotate = on
                   top = on

           [buildid]
                   # Default, disable using /dev/null
                   dir = ~/.debug

           [annotate]
                   # Defaults
                   hide_src_code = false
                   use_offset = true
                   jump_arrows = true
                   show_nr_jumps = false

           [help]
                   # Format can be man, info, web or html
                   format = man
                   autocorrect = 0

           [ui]
                   show-headers = true

           [call-graph]
                   # fp (framepointer), dwarf
                   record-mode = fp
                   print-type = graph
                   order = caller
                   sort-key = function

           [report]
                   # Defaults
                   sort_order = comm,dso,symbol
                   percent-limit = 0
                   queue-size = 0
                   children = true
                   group = true
                   skip-empty = true
```

--------------------------------

### Repair per-user installation

Source: https://man7.org/linux/man-pages/man1/flatpak-repair.1.html

Run flatpak repair for the per-user installation using the --user option. This is the second example from the EXAMPLES section.

```shell
$ flatpak repair --user
```

--------------------------------

### Example: creating a bibliographic database and running refer

Source: https://man7.org/linux/man-pages/man1/refer.1.html

Shows how to create a sample database file and run refer with the -p option to process a document that cites the entry.

```text
       $ **cat > my-db-file**
       **%A Daniel P.\& Friedman**
       **%A Matthias Felleisen**
       **%C Cambridge, Massachusetts**
       **%D 1996**
       **%I The MIT Press**
       **%T The Little Schemer, Fourth Edition**
       $ **refer -p my-db-file**
       **Read the book**
       **.[**
       **friedman**
       **.]**
       **on your summer vacation.**
       _<Control+D>_
       .lf 1 -
       Read the book\*([.1\*(.]
       .ds [F 1
       .]-
       .ds [A Daniel P. Friedman and Matthias Felleisen
       .ds [C Cambridge, Massachusetts
       .ds [D 1996
       .ds [I The MIT Press
       .ds [T The Little Schemer, Fourth Edition
       .nr [T 0
       .nr [A 0
       .][ 2 book
       .lf 5 -
       on your summer vacation.

```

--------------------------------

### Repair system installation with sudo

Source: https://man7.org/linux/man-pages/man1/flatpak-repair.1.html

Run flatpak repair with root privileges to repair the system-wide installation. This is the primary example from the EXAMPLES section.

```shell
$ sudo flatpak repair
```

--------------------------------

### curl -G/--get examples

Source: https://man7.org/linux/man-pages/man1/curl.1.html

Examples for the -G/--get option, which makes data specified with -d/--data, --data-binary, or --data-urlencode be used in an HTTP GET request instead of POST. The examples show basic usage, with data, and with -I/--head.

```shell
curl --get https://example.com
```

```shell
curl --get -d "tool=curl" -d "age=old" https://example.com
```

```shell
curl --get -I -d "tool=curl" https://example.com
```

--------------------------------

### dh_installexamples FILES section

Source: https://man7.org/linux/man-pages/man1/dh_installexamples.1.html

Documents the debian/package.examples file, including the recommendation to use examples/* instead of examples, and support for substitution variables in compat 13 and later.

```text
       debian/_package_.examples
           Lists example files or directories to be installed.

           If upstream provides an _examples_ directory, you will often
           want to use **examples/* **rather than **examples **in this file.  The
           latter would create _/usr/share/doc/package/examples/examples_,
           which is rarely what you want.

           Supports substitution variables in compat 13 and later as
           documented in debhelper(7).

```

--------------------------------

### gitweb.conf description and example

Source: https://man7.org/linux/man-pages/man5/gitweb.conf.5.html

Explains the configuration file syntax and provides an example setting $projectroot and $site_name.

```text
       The gitweb CGI script for viewing Git repositories over the web
       uses a perl script fragment as its configuration file. You can set
       variables using "**our $variable = value**"; text from a "#" character
       until the end of a line is ignored. See **perlsyn**(1) for details.

       An example:

           # gitweb configuration file for http://git.example.org
           #
           our $projectroot = "/srv/git"; # FHS recommendation
           our $site_name = 'Example.org >> Repos';

       The configuration file is used to override the default settings
       that were built into gitweb at the time the _gitweb.cgi_ script was
       generated.

       While one could just alter the configuration settings in the
       gitweb CGI itself, those changes would be lost upon upgrade.
       Configuration settings might also be placed into a file in the
       same directory as the CGI script with the default name
       _gitweb_config.perl_ — allowing one to have multiple gitweb
       instances with different configurations by the use of symlinks.

       Note that some configuration can be controlled on per-repository
       rather than gitweb-wide basis: see "Per-repository gitweb
       configuration" subsection on gitweb(1) manpage.

```

--------------------------------

### dh_installexamples OPTIONS section

Source: https://man7.org/linux/man-pages/man1/dh_installexamples.1.html

Documents the command-line options: -A/--all, --sourcedir, --doc-main-package, -X/--exclude, and file arguments.

```text
       **-A**, **--all**
           Install any files specified by command line parameters in ALL
           packages acted on.

       **--sourcedir=**_dir_
           Look in the specified directory for files to be installed.
           This option requires compat 11 or later (it is silently
           ignored in compat 10 or earlier).

           Note that this is not the same as the **--sourcedirectory **option
           used by the **dh_auto_**_*_ commands. You rarely need to use this
           option, since **dh_installexamples **automatically looks for files
           in _debian/tmp_ in debhelper compatibility level 11 and above.

       **--doc-main-package=**_main-package_
           Set the main package for a documentation package.  This is
           used to install the documentation of the documentation package
           in _/usr/share/doc/main-package_ as recommended by the Debian
           policy manual 3.9.7 in §12.3.

           In compat 11 (or later), this option is only useful if
           debhelper's auto-detection of the main package is wrong.  The
           option can also be used to silence a warning from debhelper
           when the auto-detection fails but the default happens to be
           correct.

           This option cannot be used when **dh_installexamples **is
           instructed to act on multiple packages.  If you need this
           option, you will generally need to combine it with **-p **to
           ensure exactly one package is acted on.

           The **X-Doc-Main-Package **field can be used instead since
           **debhelper/13.28**. It has similar semantics but does not require
           command line options.

       **-X**_item_, **--exclude=**_item_
           Exclude files that contain _item_ anywhere in their filename
           from being installed.

       _file_ ...
           Install these files (or directories) as examples into the
           first package acted on. (Or into all packages if **-A **is
           specified.)

```
Tokens:
Raw