diff options
Diffstat (limited to 'src/man/firecfg.1.in')
-rw-r--r-- | src/man/firecfg.1.in | 149 |
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 | ||
3 | Firecfg \- Desktop integration utility for Firejail software. | ||
4 | .SH SYNOPSIS | ||
5 | firecfg [OPTIONS] | ||
6 | .SH DESCRIPTION | ||
7 | Firecfg is the desktop integration utility for Firejail sandbox. | ||
8 | It allows the user to sandbox applications automatically by | ||
9 | clicking on desktop manager icons and menus. | ||
10 | |||
11 | The 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 | ||
24 | desktop managers are supported in this moment | ||
25 | .RE | ||
26 | |||
27 | To set it up, run "sudo firecfg" after installing Firejail software. | ||
28 | The same command should also be run after | ||
29 | installing new programs. If the program is supported by Firejail, the symbolic link in /usr/local/bin | ||
30 | will be created. For a full list of programs supported by default run "cat /etc/firejail/firecfg.config". | ||
31 | |||
32 | For user-driven manual integration, see \fBDESKTOP INTEGRATION\fR section in \fBman 1 firejail\fR. | ||
33 | .SH DEFAULT ACTIONS | ||
34 | The 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] | ||
56 | Add the list of users to Firejail user access database. | ||
57 | |||
58 | Example: | ||
59 | .br | ||
60 | $ sudo firecfg --add-users dustin lucas mike eleven | ||
61 | |||
62 | .TP | ||
63 | \fB\-\-bindir=directory | ||
64 | Create and search symbolic links in directory instead of the default location /usr/local/bin. | ||
65 | Directory should precede /usr/bin and /bin in the PATH environment variable. | ||
66 | |||
67 | .TP | ||
68 | \fB\-\-clean | ||
69 | Remove all firejail symbolic links. | ||
70 | |||
71 | .TP | ||
72 | \fB\-\-fix | ||
73 | Fix .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/. | ||
75 | This 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 | ||
79 | Create a proper ~/.config/pulse/client.conf file without shm support. On some PulseAudio versions, | ||
80 | shared memory support (shm) breaks the process ID namespace. PulseAudio software was designed | ||
81 | a long time ago, and the introduction of PID namespace in Linux kernel breaks their design. This was | ||
82 | reportedly 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 | ||
86 | Guided configuration for new users. | ||
87 | .br | ||
88 | |||
89 | .br | ||
90 | Example: | ||
91 | .br | ||
92 | $ sudo firecfg --guide | ||
93 | .br | ||
94 | .TP | ||
95 | \fB\-\-debug | ||
96 | Print debug messages. | ||
97 | .TP | ||
98 | \fB\-?\fR, \fB\-\-help\fR | ||
99 | Print options end exit. | ||
100 | .TP | ||
101 | \fB\-\-list | ||
102 | List all firejail symbolic links | ||
103 | .TP | ||
104 | \fB\-\-version | ||
105 | Print program version and exit. | ||
106 | |||
107 | |||
108 | .PP | ||
109 | Example: | ||
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 | ||
139 | This 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 | ||
141 | Homepage: 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 : | ||