Skip to content

Commit

Permalink
docs: man: fix wrong escapes (#6474)
Browse files Browse the repository at this point in the history
Remove extranous escape characters and fix bold escaping.

Command used to check for unusual escape sequences:

    $ git grep -E -e '\\f[^BR]' -e '\\[^ "\f-]' -- src/man/*.in

With this, the only escape sequences used are:

    $ git grep -E -ho -e '\\-' -e '\\[^-][^ ]?' -- src/man/*.in |
      LC_ALL=C sort | uniq -c
          9 \"
          1 \&.
       1194 \-
         23 \\
        507 \fB
        127 \fR

Related commits:

* 1379851 ("Baseline firejail 0.9.28", 2015-08-08)
* 1684c9e ("Fixes for man firejail (#2628)", 2019-03-29)
* 7352501 ("Clarify that file globbing occurs only at start",
  2020-04-11) / PR #3347
* f54ee53 ("man text for --include command", 2021-03-05).

This is a follow-up to #6472.

Kind of relates to #5903.
  • Loading branch information
kmk3 authored Sep 13, 2024
1 parent b3d6930 commit ef5ca49
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion src/man/firejail-profile.5.in
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ host filesystem. Each line describes a file/directory that is inaccessible
a tmpfs mounted on top of an existing directory (\fBtmpfs\fR),
or mount-bind a directory or file on top of another directory or file (\fBbind\fR).
Use \fBprivate\fR to set private mode. File globbing is supported, and PATH and
HOME directories are searched, see the \fBfirejail\f(1) \fBFILE GLOBBING\fR section
HOME directories are searched, see the \fBfirejail\fR(1) \fBFILE GLOBBING\fR section
for more details.
Examples:
.TP
Expand Down
24 changes: 12 additions & 12 deletions src/man/firejail.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -951,7 +951,7 @@ $ firejail \-\-ignore="net eth0" firefox
#endif

.TP
\fB\-\-\include=file.profile
\fB\-\-include=file.profile
Include a profile file before the regular profiles are used.
.br

Expand Down Expand Up @@ -1018,7 +1018,7 @@ in case you intend to start an external DHCP client in the sandbox.
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-\ip=none
$ firejail \-\-net=eth0 \-\-ip=none
.br

.br
Expand Down Expand Up @@ -1070,7 +1070,7 @@ default gateway is assigned by default.
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-\iprange=192.168.1.100,192.168.1.150
$ firejail \-\-net=eth0 \-\-iprange=192.168.1.100,192.168.1.150

.TP
\fB\-\-ipc-namespace
Expand Down Expand Up @@ -3453,37 +3453,37 @@ $ firejail --tree
1221:netblue:/usr/lib/firefox/firefox
.RE

We provide a tool that automates all this integration, please see \&\flfirecfg\fR\|(1) for more details.
We provide a tool that automates all this integration, please see \fBfirecfg\fR(1) for more details.

.SH EXAMPLES
.TP
\f\firejail
\fBfirejail
Sandbox a regular shell session.
.TP
\f\firejail firefox
\fBfirejail firefox
Start Mozilla Firefox.
.TP
\f\firejail \-\-debug firefox
\fBfirejail \-\-debug firefox
Debug Firefox sandbox.
.TP
\f\firejail \-\-private firefox
\fBfirejail \-\-private firefox
Start Firefox with a new, empty home directory.
.TP
\f\firejail --net=none vlc
\fBfirejail --net=none vlc
Start VLC in an unconnected network namespace.
#ifdef HAVE_NETWORK
.TP
\f\firejail \-\-net=eth0 firefox
\fBfirejail \-\-net=eth0 firefox
Start Firefox in a new network namespace. An IP address is
assigned automatically.
.TP
\f\firejail \-\-net=br0 \-\-ip=10.10.20.5 \-\-net=br1 \-\-net=br2
\fBfirejail \-\-net=br0 \-\-ip=10.10.20.5 \-\-net=br1 \-\-net=br2
Start a shell session in a new network namespace and connect it
to br0, br1, and br2 host bridge devices. IP addresses are assigned
automatically for the interfaces connected to br1 and b2
#endif
.TP
\f\firejail \-\-list
\fBfirejail \-\-list
List all sandboxed processes.

.SH FILE GLOBBING
Expand Down

0 comments on commit ef5ca49

Please sign in to comment.