From 76bd5ad0f8347bc111c30f67b2eb151c2e5870ed Mon Sep 17 00:00:00 2001 From: "Kelvin M. Klann" Date: Wed, 12 Jul 2023 01:55:07 -0300 Subject: 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). --- src/man/firecfg.1.in | 149 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 src/man/firecfg.1.in (limited to 'src/man/firecfg.1.in') 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 @@ +.TH FIRECFG 1 "MONTH YEAR" "VERSION" "firecfg man page" +.SH NAME +Firecfg \- Desktop integration utility for Firejail software. +.SH SYNOPSIS +firecfg [OPTIONS] +.SH DESCRIPTION +Firecfg is the desktop integration utility for Firejail sandbox. +It allows the user to sandbox applications automatically by +clicking on desktop manager icons and menus. + +The integration covers: +.br +.PP +.RS +- programs started in a terminal - typing "firefox" would be enough to start a sandboxed Firefox browser +.br + +.br +- programs started by clicking on desktop manager menus - all major desktop managers are supported +.br + +.br +- programs started by clicking on file icons in file manager - only Cinnamon, KDE, LXDE/LXQT, MATE and XFCE +desktop managers are supported in this moment +.RE + +To set it up, run "sudo firecfg" after installing Firejail software. +The same command should also be run after +installing new programs. If the program is supported by Firejail, the symbolic link in /usr/local/bin +will be created. For a full list of programs supported by default run "cat /etc/firejail/firecfg.config". + +For user-driven manual integration, see \fBDESKTOP INTEGRATION\fR section in \fBman 1 firejail\fR. +.SH DEFAULT ACTIONS +The following actions are implemented by default by running sudo firecfg: + +.RS +- set or update the symbolic links for desktop integration; +.br + +.br +- add the current user to Firejail user access database (firecfg --add-users); +.br + +.br +- fix desktop files in $HOME/.local/share/applications/ (firecfg --fix). +.br +#ifdef HAVE_APPARMOR +.br +- automatically loads and forces the AppArmor profile "firejail-default". +#endif +.RE + +.SH OPTIONS +.TP +\fB\-\-add-users user [user] +Add the list of users to Firejail user access database. + +Example: +.br +$ sudo firecfg --add-users dustin lucas mike eleven + +.TP +\fB\-\-bindir=directory +Create and search symbolic links in directory instead of the default location /usr/local/bin. +Directory should precede /usr/bin and /bin in the PATH environment variable. + +.TP +\fB\-\-clean +Remove all firejail symbolic links. + +.TP +\fB\-\-fix +Fix .desktop files. Some .desktop files use full path to executable. Firecfg will check .desktop files in +/usr/share/applications/, replace full path by name if it is in PATH, and write result to $HOME/.local/share/applications/. +This action is done by default when running "sudo firecfg". We have it as a separate option for regular users. + +.TP +\fB\-\-fix-sound +Create a proper ~/.config/pulse/client.conf file without shm support. On some PulseAudio versions, +shared memory support (shm) breaks the process ID namespace. PulseAudio software was designed +a long time ago, and the introduction of PID namespace in Linux kernel breaks their design. This was +reportedly fixed in PulseAudio version 9. If you have sound problems on your system, run +"firecfg --fix-sound" command in a terminal, followed by logout/login in order to apply the changes. +.TP +\fB\-\-guide +Guided configuration for new users. +.br + +.br +Example: +.br +$ sudo firecfg --guide +.br +.TP +\fB\-\-debug +Print debug messages. +.TP +\fB\-?\fR, \fB\-\-help\fR +Print options end exit. +.TP +\fB\-\-list +List all firejail symbolic links +.TP +\fB\-\-version +Print program version and exit. + + +.PP +Example: +.br + +.br +$ sudo firecfg +.br +/usr/local/bin/firefox created +.br +/usr/local/bin/vlc created +.br +[...] +.br +$ firecfg --list +.br +/usr/local/bin/firefox +.br +/usr/local/bin/vlc +.br +[...] +.br +$ sudo firecfg --clean +.br +/usr/local/bin/firefox removed +.br +/usr/local/bin/vlc removed +.br +[...] + + +.SH LICENSE +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. +.PP +Homepage: https://firejail.wordpress.com +.SH SEE ALSO +.BR firejail (1), +.BR firemon (1), +.BR firejail-profile (5), +.BR firejail-login (5), +.BR firejail-users (5), +.BR jailcheck (1) +.\" vim: set filetype=groff : -- cgit v1.2.3-54-g00ecf