commit 5a16652e9cb3f9e30743a90ba87282853706e604
parent 5092b0a5d08372bb2de151ca6797dca42b45a3e1
Author: Jake Bauer <jbauer@paritybit.ca>
Date: Wed, 17 Aug 2022 19:35:11 -0400
Add missing documentation
Diffstat:
| M | sbs.1 | | | 14 | ++++++++++++-- |
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/sbs.1 b/sbs.1
@@ -46,6 +46,13 @@ Note that if a subdirectory is specified for any given path, that subdirectory
must already exist.
.Nm
will not create subdirectories for you.
+.It Cm push
+Executes the "pushcmd" command specified in the configuration file. Intended to
+be used to deploy the contents of the static/ directory.
+.It Cm version
+Prints the version number of
+.Nm
+..
.El
.Sh SITE CONFIGURATION
A site created by
@@ -72,8 +79,11 @@ The arguments passed to lowdown which tell it how to compile given pages. This
option is set to a sensible default and should not be changed under normal
circumstances.
.It pushcmd
-The command sbs will use for publishing your site (e.g. rsync -rv static/*
-user@website:/var/www/html, ssh user@website "cd /var/www/html; git pull", etc.)
+An arbitrary shell command executed by
+.Nm
+when using the "push" command. Intended to be used for publishing your site
+(e.g. rsync -rv static/* user@website:/var/www/html, ssh user@website "cd
+/var/www/html; git pull", etc.)
.El
.Sh EXIT STATUS
.Nm
