aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Ouellette <aouellette2016@gmail.com>2016-03-01 10:23:45 -0500
committerAaron Ouellette <aouellette2016@gmail.com>2016-03-01 10:23:45 -0500
commit133009b652e794bee083dbeb2fbdd2db787e84c6 (patch)
tree2a38d8de9d2c735a49a2715d5100e2ec57f8b23e
parent79bfd620d6f7a3d089898ec6391411c2c6b22668 (diff)
add a manpage for swaylock
-rw-r--r--swaylock/CMakeLists.txt2
-rw-r--r--swaylock/swaylock.1.txt46
2 files changed, 48 insertions, 0 deletions
diff --git a/swaylock/CMakeLists.txt b/swaylock/CMakeLists.txt
index ff76cdbc..08c893ca 100644
--- a/swaylock/CMakeLists.txt
+++ b/swaylock/CMakeLists.txt
@@ -42,3 +42,5 @@ install(
DESTINATION ${CMAKE_INSTALL_SYSCONFDIR}/pam.d/
COMPONENT data
)
+
+add_manpage(swaylock 1)
diff --git a/swaylock/swaylock.1.txt b/swaylock/swaylock.1.txt
new file mode 100644
index 00000000..04594fd0
--- /dev/null
+++ b/swaylock/swaylock.1.txt
@@ -0,0 +1,46 @@
+/////
+vim:set ts=4 sw=4 tw=82 noet:
+/////
+:quotes.~:
+
+swaylock (1)
+============
+
+Name
+----
+swaylock - Screen locker for sway
+
+Synopsis
+--------
+'swaylock' [options]
+
+Lock the current sway session.
+
+Options
+-------
+
+*-h, --help*::
+ Show help message and quit.
+
+*-c, \--color* <rrggbb[aa]>::
+ Turn the screen into the given color instead of white.
+
+*-i, \--image* <path>::
+ Display the given image.
+
+*-s, \--scaling*::
+ Scaling mode for images: stretch, fill, fit, center, or tile.
+
+*-t, --tiling*::
+ Same as --scaling=tile.
+
+*-v, \--version*::
+ Show the version number and quit.
+
+Authors
+-------
+
+Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
+source contributors. For more information about sway development, see
+<https://github.com/SirCmpwn/sway>.
+