aboutsummaryrefslogtreecommitdiffstats
path: root/src/man/firemon.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'src/man/firemon.1.in')
-rw-r--r--src/man/firemon.1.in118
1 files changed, 118 insertions, 0 deletions
diff --git a/src/man/firemon.1.in b/src/man/firemon.1.in
new file mode 100644
index 000000000..fb0cf1175
--- /dev/null
+++ b/src/man/firemon.1.in
@@ -0,0 +1,118 @@
1.TH FIREMON 1 "MONTH YEAR" "VERSION" "firemon man page"
2.SH NAME
3Firemon \- Monitoring program for processes started in a Firejail sandbox.
4.SH SYNOPSIS
5firemon [OPTIONS] [PID]
6.SH DESCRIPTION
7Firemon monitors programs started in a Firejail sandbox.
8Without a PID specified, all processes started by Firejail are monitored. Descendants of
9these processes are also being monitored. On Grsecurity systems only root user
10can run this program.
11.SH OPTIONS
12.TP
13\fB\-\-apparmor
14Print AppArmor confinement status for each sandbox.
15#ifdef HAVE_NETWORK
16.TP
17\fB\-\-arp
18Print ARP table for each sandbox.
19#endif
20.TP
21\fB\-\-caps
22Print capabilities configuration for each sandbox.
23.TP
24\fB\-\-cpu
25Print CPU affinity for each sandbox.
26.TP
27\fB\-\-debug
28Print debug messages
29.TP
30\fB\-?\fR, \fB\-\-help\fR
31Print options end exit.
32.TP
33\fB\-\-list
34List all sandboxes.
35.TP
36\fB\-\-name=name
37Print information only about named sandbox.
38#ifdef HAVE_NETWORK
39.TP
40\fB\-\-netstats
41Monitor network statistics for sandboxes creating a new network namespace.
42#endif
43#ifdef HAVE_NETWORK
44.TP
45\fB\-\-route
46Print route table for each sandbox.
47#endif
48.TP
49\fB\-\-seccomp
50Print seccomp configuration for each sandbox.
51.TP
52\fB\-\-top
53Monitor the most CPU-intensive sandboxes. This command is similar to
54the regular UNIX top command, however it applies only to sandboxes.
55.TP
56\fB\-\-tree
57Print a tree of all sandboxed processes.
58.TP
59\fB\-\-version
60Print program version and exit.
61.TP
62\fB\-\-wrap
63Enable line wrapping in terminals. By default the lines are trimmed.
64.TP
65\fB\-\-x11
66Print X11 display number.
67
68.PP
69The format for each listed sandbox entry is as follows:
70
71 PID:USER:Sandbox Name:Command
72
73Listed below are the available fields (columns) in various firemon commands in alphabetical order:
74
75.TP
76Command
77Command used to start the sandbox.
78.TP
79CPU%
80CPU usage, the sandbox share of the elapsed CPU time since the
81last screen update
82.TP
83PID
84Unique process ID for the task controlling the sandbox.
85.TP
86Prcs
87Number of processes running in sandbox, including the controlling process.
88.TP
89RES
90Resident Memory Size (KiB), sandbox non-swapped physical memory.
91It is a sum of the RES values for all processes running in the sandbox.
92.TP
93Sandbox Name
94The name of the sandbox, if any.
95.TP
96SHR
97Shared Memory Size (KiB), it reflects memory shared with other
98processes. It is a sum of the SHR values for all processes running
99in the sandbox, including the controlling process.
100.TP
101Uptime
102Sandbox running time in hours:minutes:seconds format.
103.TP
104USER
105The owner of the sandbox.
106
107.SH LICENSE
108This 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.
109.PP
110Homepage: https://firejail.wordpress.com
111.SH SEE ALSO
112.BR firejail (1),
113.BR firecfg (1),
114.BR firejail-profile (5),
115.BR firejail-login (5),
116.BR firejail-users (5),
117.BR jailcheck (1)
118.\" vim: set filetype=groff :