From 76bd5ad0f8347bc111c30f67b2eb151c2e5870ed Mon Sep 17 00:00:00 2001
From: "Kelvin M. Klann" <kmk3.code@protonmail.com>
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/firemon.1.in | 118 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 118 insertions(+)
 create mode 100644 src/man/firemon.1.in

(limited to 'src/man/firemon.1.in')

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 @@
+.TH FIREMON 1 "MONTH YEAR" "VERSION" "firemon man page"
+.SH NAME
+Firemon \- Monitoring program for processes started in a Firejail sandbox.
+.SH SYNOPSIS
+firemon [OPTIONS] [PID]
+.SH DESCRIPTION
+Firemon monitors programs started in a Firejail sandbox.
+Without a PID specified, all processes started by Firejail are monitored. Descendants of
+these processes are also being monitored. On Grsecurity systems only root user
+can run this program.
+.SH OPTIONS
+.TP
+\fB\-\-apparmor
+Print AppArmor confinement status for each sandbox.
+#ifdef HAVE_NETWORK
+.TP
+\fB\-\-arp
+Print ARP table for each sandbox.
+#endif
+.TP
+\fB\-\-caps
+Print capabilities configuration for each sandbox.
+.TP
+\fB\-\-cpu
+Print CPU affinity for each sandbox.
+.TP
+\fB\-\-debug
+Print debug messages
+.TP
+\fB\-?\fR, \fB\-\-help\fR
+Print options end exit.
+.TP
+\fB\-\-list
+List all sandboxes.
+.TP
+\fB\-\-name=name
+Print information only about named sandbox.
+#ifdef HAVE_NETWORK
+.TP
+\fB\-\-netstats
+Monitor network statistics for sandboxes creating a new network namespace.
+#endif
+#ifdef HAVE_NETWORK
+.TP
+\fB\-\-route
+Print route table for each sandbox.
+#endif
+.TP
+\fB\-\-seccomp
+Print seccomp configuration for each sandbox.
+.TP
+\fB\-\-top
+Monitor the most CPU-intensive sandboxes. This command is similar to
+the regular UNIX top command, however it applies only to sandboxes.
+.TP
+\fB\-\-tree
+Print a tree of all sandboxed processes.
+.TP
+\fB\-\-version
+Print program version and exit.
+.TP
+\fB\-\-wrap
+Enable line wrapping in terminals. By default the lines are trimmed.
+.TP
+\fB\-\-x11
+Print X11 display number.
+
+.PP
+The format for each listed sandbox entry is as follows:
+
+	PID:USER:Sandbox Name:Command
+
+Listed below are the available fields (columns) in various firemon commands in alphabetical order:
+
+.TP
+Command
+Command used to start the sandbox.
+.TP
+CPU%
+CPU usage, the sandbox share of the elapsed CPU time since the
+last screen update
+.TP
+PID
+Unique process ID for the task controlling the sandbox.
+.TP
+Prcs
+Number of processes running in sandbox, including the controlling process.
+.TP
+RES
+Resident Memory Size (KiB), sandbox non-swapped physical memory.
+It is a sum of the RES values for all processes running in the sandbox.
+.TP
+Sandbox Name
+The name of the sandbox, if any.
+.TP
+SHR
+Shared Memory Size (KiB), it reflects memory shared with other
+processes. It is a sum of the SHR values for all processes running
+in the sandbox, including the controlling process.
+.TP
+Uptime
+Sandbox running time in hours:minutes:seconds format.
+.TP
+USER
+The owner of the sandbox.
+
+.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 firecfg (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