add man pages

2 files changed, 61 insertions, 0 deletions

diff --git a/src/usr/share/man/man1/myautomount-trayicon.1.txt b/src/usr/share/man/man1/myautomount-trayicon.1.txt
new file mode 100644
index 0000000..399c939
--- /dev/null
+++ b/src/usr/share/man/man1/myautomount-trayicon.1.txt
@@ -0,0 +1,24 @@
+title myautomount-trayicon
+section 1
+project myautomount
+volume General Commands Manual
+date September 2020
+=====
+NAME
+  myautomount-trayicon - system tray icon that shows links to removable media drives
+SYNOPSIS
+  myautomount-trayicon
+DESCRIPTION
+Myautomount tray icon provides a Gtk3-themed icon and menu that the system tray daemon can consume. Left- or right- clicking the icon will show the currently available drives, that are discovered by myautomountd(1).
+CONFIGURATION
+See myautomountd(1) section CONFIGURATION for available settings in `/etc/myautomount.conf`.
+LICENSE
+CC-BY-SA-4.0
+AUTHOR
+<bgstack15@gmail.com>
+BUGS
+The polling when hidden or when using XApp support sometimes can end up running twice.
+Sometimes the icon can hide itself even though there are removable media drives present.
+Contribute any bug reports, patches, or comments to <https://gitlab.com/bgstack15/myautomount>
+SEE ALSO
+myautomountd(1)
diff --git a/src/usr/share/man/man1/myautomountd.1.txt b/src/usr/share/man/man1/myautomountd.1.txt
new file mode 100644
index 0000000..f9a32c8
--- /dev/null
+++ b/src/usr/share/man/man1/myautomountd.1.txt
@@ -0,0 +1,37 @@
+title myautomountd
+section 1
+project myautomount
+volume General Commands Manual
+date September 2020
+=====
+NAME
+  myautomountd - daemon that generates xdg-desktop files for removable media
+SYNOPSIS
+  myautomountd
+DESCRIPTION
+Myautomount daemon wraps around udevadm and sets up .desktop files in a designated directory for the discovered removable media. The definition of "discovered" here is anything that is added after the daemon is started, which is the main reason the daemon is designed to be run at X start time at user login. An xdg autostart shortcut is provided which should start up this daemon for you.
+Myautomount avoids the use of dbus, which is a main reason it exists.
+CONFIGURATION
+The global config is set in `/etc/myautomount.conf`. This is actually a shell script that is dot-sourced by the daemon. The file `${HOME}/.config/myautomount.conf` can be user on a per-user basis.
+All variables must be exported to be picked up by the program.
+  INITIALIZATION VARIABLES
+* AUTOMOUNT_DIR  Where the auto.master.d directory resides, which is usually controlled per distro.
+* AUTOMOUNT_DIR_FILE  The full path to the file inside auto.master.md where the autofs definitions belong.
+* AUTOMOUNT_FILE  The full path to the autofs.myautomount file which is the other half of autofs definitions.
+  DAEMON VARIABLES
+* AUTOMOUNT_BASEDIR  Where the .desktop files go. This will be consumed by the trayicon.
+  TRAYICON VARIABLES
+* AUTOMOUNT_BASEDIR  See `DAEMON VARIABLES` above.
+* showmount  0 or 1. Default 1. Show "MOUNTED" for each partition that is currently mounted.
+* skip_sd_without_partitions  0 or 1. Default 1. Skip sdb, sdc, etc. NOT CURRENTLY IMPLEMENTED!
+* only_update_on_menuitem  0 or 1. Default 0. Disable the mouseover poll. If 1, it breaks showmount=1.
+* hide_when_no_media  0 or 1. Default 1. Stay hidden until some removable media is discovered.
+LICENSE
+BSD-2-Clause
+AUTHORS
+This shell script started off as a one-to-one translation of a Go program published by the Project Trident team <https://github.com/project-trident/trident-utilities/blob/master/src-go/automount/main.go>.
+Translated by <bgstack15@gmail.com>
+BUGS
+Contribute any bug reports, patches, or comments to <https://gitlab.com/bgstack15/myautomount>
+SEE ALSO
+myautomount-trayicon(1)