aboutsummaryrefslogtreecommitdiff
path: root/swaylock
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2016-03-18 17:15:19 -0400
committerDrew DeVault <sir@cmpwn.com>2016-03-18 17:15:19 -0400
commit7fb2a16275376c4e2183fa6b2cde5c6afc704103 (patch)
treed958fae88ea43df2e707830e5f6ca9bf6975a491 /swaylock
parent378a45cec23b76732a19d0027e1bba3ef2bf3752 (diff)
parent8af6a419ec6f4cfc596aabd5c820e7033cc760c4 (diff)
Merge pull request #520 from aouelete/swaylock
Add a manpage for swaylock
Diffstat (limited to '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>.
+