From 4afb8d863674509df5a42020b5e782c3f2e27017 Mon Sep 17 00:00:00 2001
From: tobi-wan-kenobi <tobi-wan-kenobi@users.noreply.github.com>
Date: Wed, 8 Jun 2022 08:32:35 +0200
Subject: [PATCH] [doc] add man pages

Many thanks to https://github.com/benthetechguy, who wrote man pages for
bumblebee-status and bumblebee-ctl

fixes #882
---
 man/bumblebee-ctl.1    | 29 +++++++++++++++++++++
 man/bumblebee-status.1 | 58 ++++++++++++++++++++++++++++++++++++++++++
 setup.py               |  1 +
 3 files changed, 88 insertions(+)
 create mode 100644 man/bumblebee-ctl.1
 create mode 100644 man/bumblebee-status.1

diff --git a/man/bumblebee-ctl.1 b/man/bumblebee-ctl.1
new file mode 100644
index 0000000..33c50aa
--- /dev/null
+++ b/man/bumblebee-ctl.1
@@ -0,0 +1,29 @@
+.TH BUMBLEBEE-CTL "1" "June 2022" "bumblebee-status"
+.SH NAME
+bumblebee-ctl \- Send commands to bumblebee-status
+.SH SYNOPSIS
+.B bumblebee-ctl
+[\fB\-h\fR] [\fB\-b\fR \fIbutton\fR] [\fB\-i\fR \fIID\fR] \fB-m\fR \fImodule\fR
+.SH DESCRIPTION
+.B bumblebee-ctl
+can be used to send commands to bumblebee-status.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-b\fR, \fB\-\-button\fR <button>
+Button to emulate. Buttons can be any of left\-mouse, right\-mouse,
+middle\-mouse, wheel\-up, wheel\-down, or update.
+.TP
+\fB\-i\fR, \fB\-\-id\fR <ID>
+ID of widget to trigger
+.TP
+\fB\-m\fR, \fB\-\-module\fR <module>
+name of module to trigger
+.SH COPYRIGHT
+Copyright \(co 2016\-2022 tobi\-wan\-kenobi.
+.PP
+.br
+This is free software; see the source for copying conditions.
+There is NO WARRANTY, to the extent permitted by law.
diff --git a/man/bumblebee-status.1 b/man/bumblebee-status.1
new file mode 100644
index 0000000..9a3f521
--- /dev/null
+++ b/man/bumblebee-status.1
@@ -0,0 +1,58 @@
+.TH BUMBLEBEE-STATUS "1" "June 2022" "bumblebee-status"
+.SH NAME
+bumblebee-status \- status line generator for the i3 window manager
+.SH SYNOPSIS
+.B bumblebee-status
+[\fIoptions\fR]
+.SH DESCRIPTION
+.B bumblebee-status
+is a modular, themeable status line generator for the i3 window manager.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-c\fR, \fB\-\-config\-file\fR <config\-file>
+specify a configuration file to use
+.TP
+\fB\-m\fR, \fB\-\-modules\fR MODULES <modules>
+Specify a space\-separated list of modules to load. The order of the list
+determines their order in the i3bar (from left to right). Use
+<module>:<alias> to provide an alias in case you want to load the same
+module multiple times, but specify different parameters.
+.TP
+\fB\-p\fR, \fB\-\-parameters\fR PARAMETERS <parameters>
+provide configuration parameters in the form of <module>.<key>=<value>
+.TP
+\fB\-t\fR, \fB\-\-theme\fR <theme>
+specify the theme to use for drawing modules
+.TP
+\fB\-i\fR, \fB\-\-iconset\fR <iconset>
+specify the name of an iconset to use (overrides theme default)
+.TP
+\fB\-a\fR, \fB\-\-autohide\fR AUTOHIDE <modules>
+specify a list of modules to hide when not in warning/error state
+.TP
+\fB\-e\fR, \fB\-\-errorhide\fR ERRORHIDE <modules>
+specify a list of modules that are hidden when in state error
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+add debug fields to i3 output
+.TP
+\fB\-f\fR, \fB\-\-logfile\fR <logfile>
+destination for the debug log file, if \fB\-d\fR or \fB\-\-debug\fR
+is specified; defaults to stderr
+.TP
+\fB\-r\fR, \fB\-\-right\-to\-left\fR
+draw widgets from right to left, rather than left to right
+(which is the default)
+.TP
+\fB\-l\fR, \fB\-\-list\fR <\fImodules\fR,\fIthemes\fR,\fImodules\-rst\fR>
+display a list of available themes or available modules,
+along with their parameters
+.SH COPYRIGHT
+Copyright \(co 2016\-2022 tobi\-wan\-kenobi.
+.PP
+.br
+This is free software; see the source for copying conditions.
+There is NO WARRANTY, to the extent permitted by law.
diff --git a/setup.py b/setup.py
index 1f6c203..a63be64 100755
--- a/setup.py
+++ b/setup.py
@@ -56,6 +56,7 @@ setup(
         ("share/bumblebee-status/themes", glob.glob("themes/*.json")),
         ("share/bumblebee-status/themes/icons", glob.glob("themes/icons/*.json")),
         ("share/bumblebee-status/utility", glob.glob("bin/*")),
+        ("usr/share/man/man1", glob.glob("man/*.1")),
     ],
     packages=find_packages(exclude=["tests", "tests.*"])
 )