Add a manual page lxhotkey.1.
authorAndriy Grytsenko <andrej@rep.kiev.ua>
Sat, 8 Oct 2016 19:12:24 +0000 (22:12 +0300)
committerAndriy Grytsenko <andrej@rep.kiev.ua>
Sat, 8 Oct 2016 19:12:24 +0000 (22:12 +0300)
Makefile.am
configure.ac
debian/lxhotkey-core.install
man/lxhotkey.1.in [new file with mode: 0644]

index b9bfa68..2be6fe8 100644 (file)
@@ -7,4 +7,6 @@ SUBDIRS = src plugins po
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = lxhotkey.pc
 
-EXTRA_DIST = autogen.sh lxhotkey.pc.in
+man_MANS = man/lxhotkey.1
+
+EXTRA_DIST = autogen.sh lxhotkey.pc.in man/lxhotkey.1.in
index 77d829f..de61baa 100644 (file)
@@ -76,5 +76,6 @@ AC_CONFIG_FILES([
     src/Makefile
     plugins/Makefile
     po/Makefile.in
+    man/lxhotkey.1
 ])
 AC_OUTPUT
diff --git a/man/lxhotkey.1.in b/man/lxhotkey.1.in
new file mode 100644 (file)
index 0000000..7a2fdba
--- /dev/null
@@ -0,0 +1,44 @@
+.\" Process this file with
+.\" groff -man -Tascii lxhotkey.1
+.\"
+.TH LXHotkey 1 "March 2016" "@PACKAGE@ @VERSION@" "User Manuals"
+.SH NAME
+LXHotkey \- A lightweight global keyboard shortcuts configurator
+.SH SYNOPSIS
+.B lxhotkey
+[ command ]
+.SH DESCRIPTION
+\fBLXHotkey\fP is an universal application for the Lightweight X11 Desktop
+Environment (\fBLXDE\fP) which allows view and change global keyboard shortcuts
+for Window Manager actions, including ones to start applications.
+.SH OPTIONS
+.SS Command line interface:
+.TP 20
+.BI global " \fR[\fIaction\fR]"
+show keys bound to \fIaction\fP(s)
+.TP
+.BI global " action key"
+bind a \fIkey\fP to the \fIaction\fP
+.TP
+.BI app " \fR[\fIexec\fR]"
+show keys bound to \fIexec\fR line
+.TP
+.BI app " exec key"
+bind a \fIkey\fR to some \fIexec\fR line
+.TP
+.BI app " exec" " \-\^\-"
+unbind all keys from \fIexec\fR line
+.TP
+.BI show " key"
+show the action bound to a \fIkey\fR
+.SS Graphic interface:
+.TP 20
+.BI "\-\^\-gui=" " type"
+start with GUI of \fItype\fR
+.SH SUPPORTED WINDOW MANAGERS
+.PD 0
+.TP
+.I Openbox
+
+.SH AUTHOR
+Initial version of LXHotkey is written by Andriy Grytsenko <andrej@rep.kiev.ua>.