aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatarJulien Valroff <julien@kirya.net>2011-11-20 10:56:20 +0100
committerLibravatarJulien Valroff <julien@kirya.net>2011-11-20 10:56:20 +0100
commit353fe4704b5a13b212ff359e8cebb4e156198610 (patch)
tree6d07db2ebe7127c258c0c58d89ce38b10cecdf8a
parent7358c269b7675e77307a4f8304ee8132303d56fa (diff)
downloadoblogout-353fe4704b5a13b212ff359e8cebb4e156198610.tar.bz2
oblogout-353fe4704b5a13b212ff359e8cebb4e156198610.tar.xz
oblogout-353fe4704b5a13b212ff359e8cebb4e156198610.tar.zst
Add manpage
-rw-r--r--debian/manpages1
-rw-r--r--debian/oblogout.158
2 files changed, 59 insertions, 0 deletions
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..5e66180
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+debian/oblogout.1
diff --git a/debian/oblogout.1 b/debian/oblogout.1
new file mode 100644
index 0000000..f58253a
--- /dev/null
+++ b/debian/oblogout.1
@@ -0,0 +1,58 @@
+.TH oblogout "1" "Nov 2011" "oblogout 0.3" "User commands"
+.SH NAME
+oblogout \- Logout script designed with Openbox in mind
+
+.SH DESCRIPTION
+\fBOBLogout\fR is a expandable, configurable, and theme-able logout script designed
+to be used in a Openbox desktop environment.
+
+OBLogout uses pyGTK/Cairo, PIL, and HAL/dbus. The code tries to remain simple
+and flexible for usage in any number of situations and is designed to run on
+desktops of any screen resolution and capabilities. If compositing isn't
+available a software rendering solution (PIL) is used instead.
+
+.SH USAGE
+\fBoblogout\fR
+
+CAIRO RENDERING IS ONLY ENABLED FOR COMPOSITED SCREENS! Rendered effects are used for ones without.
+
+.SH CONFIGURATION OPTIONS
+
+ SETTINGS
+
+ - UseHal = true/false dictate if oblogout should use HAL for it's shutdown/suspend
+ functions.
+
+ LOOKS
+
+ - Opacity = Opacity percentage of Cario rendered backgrounds
+ - Bgcolor = Colour name or hex code (#ffffff) of the background color
+
+ - Buttontheme = Icon theme for the buttons, must be in the themes folder of the
+ package, or in ~/.themes/<name>/oblogout/
+ - Buttons = List and order of buttons to show
+
+ BUTTONS
+
+ - cancel = Cancel logout/shutdown
+ - restart = Restart
+ - shutdown = Shutdown
+ - suspend = Suspend
+ - hibernate = Hibernate
+ - safesuspend = Suspend/Hibernate mix, writes Hibernate file then suspends
+ - lock = Lock session
+ - switch = Switch user
+
+ SHORTCUTS
+
+ - For each button type, define a key to use. Case insenstive.
+
+ COMMANDS
+
+ - Same as the buttons, define a command per button type
+
+.SH AUTHOR
+Andrew Williams <andy@tensixtyone.com>
+
+This manual page was written for the Debian system by
+Julien Valroff <julien@debian.org> (but may be used by others).