aboutsummaryrefslogtreecommitdiff
path: root/sdn-install.1
diff options
context:
space:
mode:
Diffstat (limited to 'sdn-install.1')
-rw-r--r--sdn-install.135
1 files changed, 35 insertions, 0 deletions
diff --git a/sdn-install.1 b/sdn-install.1
new file mode 100644
index 0000000..c186f63
--- /dev/null
+++ b/sdn-install.1
@@ -0,0 +1,35 @@
+.Dd October 27, 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
+the default one for your user.
+.It Fl s Ar shell
+If you want to integrate
+.Xr sdn 1
+with a different shell than the one you're running, use this option to specify
+it.
+.El
+.Sh REPORTING BUGS
+Use
+.Lk https://git.janouch.name/p/sdn
+to report bugs, request features, or submit pull requests.