aboutsummaryrefslogtreecommitdiffstats
path: root/src/man/firecfg.1.in
diff options
context:
space:
mode:
authorLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-07-12 01:55:07 -0300
committerLibravatar Kelvin M. Klann <kmk3.code@protonmail.com>2023-07-13 11:43:53 -0300
commit76bd5ad0f8347bc111c30f67b2eb151c2e5870ed (patch)
tree3fd235c83d6ce45451abc80dca27420203d3aad6 /src/man/firecfg.1.in
parentbuild: restore seccomp filter targets (diff)
downloadfirejail-76bd5ad0f8347bc111c30f67b2eb151c2e5870ed.tar.gz
firejail-76bd5ad0f8347bc111c30f67b2eb151c2e5870ed.tar.zst
firejail-76bd5ad0f8347bc111c30f67b2eb151c2e5870ed.zip
build: simplify code related to man pages
Simplify the main targets and use wildcards instead of repeating the filenames manually. Also, restore the `man` target and building only when `HAVE_MAN` is enabled. Note: Make automatically removes intermediate files (.1 and .5), so in general only the .gz files have to be cleaned. Commands used to rename the man pages: cd src/man git mv firecfg.txt firecfg.1.in git mv firejail-login.txt firejail-login.5.in git mv firejail-profile.txt firejail-profile.5.in git mv firejail-users.txt firejail-users.5.in git mv firejail.txt firejail.1.in git mv firemon.txt firemon.1.in git mv jailcheck.txt jailcheck.1.in This is kind of a follow-up to commit 9e206b7f2 ("rework src/man Makefile", 2023-07-07).
Diffstat (limited to 'src/man/firecfg.1.in')
-rw-r--r--src/man/firecfg.1.in149
1 files changed, 149 insertions, 0 deletions
diff --git a/src/man/firecfg.1.in b/src/man/firecfg.1.in
new file mode 100644
index 000000000..42add6a41
--- /dev/null
+++ b/src/man/firecfg.1.in
@@ -0,0 +1,149 @@
1.TH FIRECFG 1 "MONTH YEAR" "VERSION" "firecfg man page"
2.SH NAME
3Firecfg \- Desktop integration utility for Firejail software.
4.SH SYNOPSIS
5firecfg [OPTIONS]
6.SH DESCRIPTION
7Firecfg is the desktop integration utility for Firejail sandbox.
8It allows the user to sandbox applications automatically by
9clicking on desktop manager icons and menus.
10
11The integration covers:
12.br
13.PP
14.RS
15- programs started in a terminal - typing "firefox" would be enough to start a sandboxed Firefox browser
16.br
17
18.br
19- programs started by clicking on desktop manager menus - all major desktop managers are supported
20.br
21
22.br
23- programs started by clicking on file icons in file manager - only Cinnamon, KDE, LXDE/LXQT, MATE and XFCE
24desktop managers are supported in this moment
25.RE
26
27To set it up, run "sudo firecfg" after installing Firejail software.
28The same command should also be run after
29installing new programs. If the program is supported by Firejail, the symbolic link in /usr/local/bin
30will be created. For a full list of programs supported by default run "cat /etc/firejail/firecfg.config".
31
32For user-driven manual integration, see \fBDESKTOP INTEGRATION\fR section in \fBman 1 firejail\fR.
33.SH DEFAULT ACTIONS
34The following actions are implemented by default by running sudo firecfg:
35
36.RS
37- set or update the symbolic links for desktop integration;
38.br
39
40.br
41- add the current user to Firejail user access database (firecfg --add-users);
42.br
43
44.br
45- fix desktop files in $HOME/.local/share/applications/ (firecfg --fix).
46.br
47#ifdef HAVE_APPARMOR
48.br
49- automatically loads and forces the AppArmor profile "firejail-default".
50#endif
51.RE
52
53.SH OPTIONS
54.TP
55\fB\-\-add-users user [user]
56Add the list of users to Firejail user access database.
57
58Example:
59.br
60$ sudo firecfg --add-users dustin lucas mike eleven
61
62.TP
63\fB\-\-bindir=directory
64Create and search symbolic links in directory instead of the default location /usr/local/bin.
65Directory should precede /usr/bin and /bin in the PATH environment variable.
66
67.TP
68\fB\-\-clean
69Remove all firejail symbolic links.
70
71.TP
72\fB\-\-fix
73Fix .desktop files. Some .desktop files use full path to executable. Firecfg will check .desktop files in
74/usr/share/applications/, replace full path by name if it is in PATH, and write result to $HOME/.local/share/applications/.
75This action is done by default when running "sudo firecfg". We have it as a separate option for regular users.
76
77.TP
78\fB\-\-fix-sound
79Create a proper ~/.config/pulse/client.conf file without shm support. On some PulseAudio versions,
80shared memory support (shm) breaks the process ID namespace. PulseAudio software was designed
81a long time ago, and the introduction of PID namespace in Linux kernel breaks their design. This was
82reportedly fixed in PulseAudio version 9. If you have sound problems on your system, run
83"firecfg --fix-sound" command in a terminal, followed by logout/login in order to apply the changes.
84.TP
85\fB\-\-guide
86Guided configuration for new users.
87.br
88
89.br
90Example:
91.br
92$ sudo firecfg --guide
93.br
94.TP
95\fB\-\-debug
96Print debug messages.
97.TP
98\fB\-?\fR, \fB\-\-help\fR
99Print options end exit.
100.TP
101\fB\-\-list
102List all firejail symbolic links
103.TP
104\fB\-\-version
105Print program version and exit.
106
107
108.PP
109Example:
110.br
111
112.br
113$ sudo firecfg
114.br
115/usr/local/bin/firefox created
116.br
117/usr/local/bin/vlc created
118.br
119[...]
120.br
121$ firecfg --list
122.br
123/usr/local/bin/firefox
124.br
125/usr/local/bin/vlc
126.br
127[...]
128.br
129$ sudo firecfg --clean
130.br
131/usr/local/bin/firefox removed
132.br
133/usr/local/bin/vlc removed
134.br
135[...]
136
137
138.SH LICENSE
139This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
140.PP
141Homepage: https://firejail.wordpress.com
142.SH SEE ALSO
143.BR firejail (1),
144.BR firemon (1),
145.BR firejail-profile (5),
146.BR firejail-login (5),
147.BR firejail-users (5),
148.BR jailcheck (1)
149.\" vim: set filetype=groff :