From df046bb07188c4197355c14a7069d57e1d477cc9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C5=99emysl=20Eric=20Janouch?= <p@janouch.name>
Date: Mon, 26 Oct 2020 20:46:09 +0100
Subject: [PATCH] Add some mediocre manpages

I'm not particularly happy to write in mdoc but here goes.
---
 CMakeLists.txt |  1 +
 sdn-install.1  | 30 ++++++++++++++++++++++++++++++
 sdn.1          | 38 ++++++++++++++++++++++++++++++++++++++
 3 files changed, 69 insertions(+)
 create mode 100644 sdn-install.1
 create mode 100644 sdn.1

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 0ff63f6..7518f4f 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -26,6 +26,7 @@ target_compile_definitions (${PROJECT_NAME} PUBLIC
 include (GNUInstallDirs)
 install (TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR})
 install (PROGRAMS ${PROJECT_NAME}-install DESTINATION ${CMAKE_INSTALL_BINDIR})
+install (FILES sdn.1 sdn-install.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
 install (FILES LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR})
 
 set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Directory navigator")
diff --git a/sdn-install.1 b/sdn-install.1
new file mode 100644
index 0000000..d39e07b
--- /dev/null
+++ b/sdn-install.1
@@ -0,0 +1,30 @@
+.Dd October 26, 2020
+.Dt SDN-INSTALL 1
+.Os Linux
+.Sh NAME
+.Nm sdn-install
+.Nd integrate sdn with the shell
+.Sh SYNOPSIS
+.Nm sdn-install
+.Op Fl s Ar shell
+.Op Fl p Ar - | rcpath
+.Sh DESCRIPTION
+.Nm
+integrates
+.Xr sdn 1
+with your shell, binding it to M-o.  If the navigator has already been
+integrated, it updates the snippet in-place.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl p Ar -
+Merely print the integration snippet for the appropriate shell to the standard
+output, not changing anything.
+.It Fl p Ar rcpath
+Install the integration snippet into a different shell initialization file than
+your user's default one.
+.It Fl s Ar shell
+If you want to integrate
+.Xr sdn 1
+with a different shell than you're running, use this option to specify it.
+.El
diff --git a/sdn.1 b/sdn.1
new file mode 100644
index 0000000..e449d77
--- /dev/null
+++ b/sdn.1
@@ -0,0 +1,38 @@
+.Dd October 26, 2020
+.Dt SDN 1
+.Os Linux
+.Sh NAME
+.Nm sdn
+.Nd simple directory navigator
+.Sh SYNOPSIS
+.Nm sdn
+.Op Ar line Ar point
+.Sh DESCRIPTION
+.Nm
+is a simple directory navigator that you can invoke while editing shell
+commands.  Use the
+.Xr sdn-install 1
+script to integrate it with your shell, then invoke it with M-o.
+.Sh ENVIRONMENT
+.Bl -tag -width 15n
+.It Ev LS_COLORS
+Used to retrieve filename colours.  The format is described in
+.Xr dir_colors 5
+and you can use the
+.Xr dircolors 1
+utility to initialize this variable.
+.It Ev PAGER
+The viewer program to be launched by the F3 key binding as well as to show
+the internal help message.
+.It Ev VISUAL , Ev EDITOR
+The editor program to be launched by the F4 key binding.
+.El
+.Sh FILES
+.Bl -tag -width 25n -compact
+.It Pa ~/.config/sdn/config
+Program configuration and state.
+.It Pa ~/.config/sdn/bindings
+Key binding overrides.
+.It Pa ~/.config/sdn/look
+Redefine terminal attributes for UI elements.
+.El