aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2016-04-29 01:17:38 +0200
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2016-04-29 01:17:38 +0200
commitd4003fcfc88df94831cb4a20e890816954f64129 (patch)
treecbc88d7352efc01be31b7ab9fe988e20830ff50c
parentca6fb024c9632b73713432e30fce978a99f42213 (diff)
downloadblogc-d4003fcfc88df94831cb4a20e890816954f64129.tar.gz
blogc-d4003fcfc88df94831cb4a20e890816954f64129.tar.bz2
blogc-d4003fcfc88df94831cb4a20e890816954f64129.zip
man: added man page for blogc-runserver
-rw-r--r--Makefile.am13
-rw-r--r--blogc.spec.in1
-rw-r--r--man/blogc-git-receiver.1.ronn2
-rw-r--r--man/blogc-runserver.1.ronn48
-rw-r--r--man/index.txt1
5 files changed, 64 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index 78b29e0..6b428cb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -180,9 +180,11 @@ endif
if BUILD_RUNSERVER
EXTRA_DIST += \
+ man/blogc-runserver.1.ronn \
$(NULL)
dist_man_MANS += \
+ blogc-runserver.1 \
$(NULL)
endif
@@ -208,6 +210,14 @@ blogc-git-receiver.1: man/blogc-git-receiver.1.ronn
--manual "$(PACKAGE_NAME) Manual" \
$(top_srcdir)/man/blogc-git-receiver.1.ronn > blogc-git-receiver.1
+blogc-runserver.1: man/blogc-runserver.1.ronn
+ $(AM_V_GEN)$(RONN) \
+ --roff \
+ --pipe \
+ --organization "Rafael G. Martins" \
+ --manual "$(PACKAGE_NAME) Manual" \
+ $(top_srcdir)/man/blogc-runserver.1.ronn > blogc-runserver.1
+
blogc-source.7: man/blogc-source.7.ronn
$(AM_V_GEN)$(RONN) \
--roff \
@@ -232,6 +242,9 @@ blogc.1:
blogc-git-receiver.1:
$(AM_V_GEN)echo "error: ronn not found. failed to build man page: $@"; exit 1
+blogc-runserver.1:
+ $(AM_V_GEN)echo "error: ronn not found. failed to build man page: $@"; exit 1
+
blogc-source.7:
$(AM_V_GEN)echo "error: ronn not found. failed to build man page: $@"; exit 1
diff --git a/blogc.spec.in b/blogc.spec.in
index 65af54f..292ed17 100644
--- a/blogc.spec.in
+++ b/blogc.spec.in
@@ -53,6 +53,7 @@ rm -rf $RPM_BUILD_ROOT
%license LICENSE
%files runserver
+%{_mandir}/man*/blogc-runserver.*
%{_bindir}/blogc-runserver
%license LICENSE
diff --git a/man/blogc-git-receiver.1.ronn b/man/blogc-git-receiver.1.ronn
index 4eadece..e26ed09 100644
--- a/man/blogc-git-receiver.1.ronn
+++ b/man/blogc-git-receiver.1.ronn
@@ -1,4 +1,4 @@
-blogc-git-receiver(1) -- A simple login shell/git hook to deploy blogc websites
+blogc-git-receiver(1) -- a simple login shell/git hook to deploy blogc websites
===============================================================================
## SYNOPSIS
diff --git a/man/blogc-runserver.1.ronn b/man/blogc-runserver.1.ronn
new file mode 100644
index 0000000..a306fbe
--- /dev/null
+++ b/man/blogc-runserver.1.ronn
@@ -0,0 +1,48 @@
+blogc-runserver(1) -- a simple HTTP server to test blogc websites
+=================================================================
+
+## SYNOPSIS
+
+`blogc-runserver` [`-t` <HOST>] [`-p` <PORT>] <DOCROOT><br>
+`blogc-runserver` [`-h`|`-v`]
+
+## DESCRIPTION
+
+**blogc-runserver** is a simple HTTP server that makes it easy to test blogc websites.
+Users just need to point it to the directory where the target files where built. It
+comes with a few pre-defined rules, similar to production webservers, that allow users
+to quickly test their websites without configuring a webserver.
+
+`blogc-runserver` is part of `blogc` project, but isn't tied to blogc(1). It may be
+able to serve any website built by static site generators.
+
+## OPTIONS
+
+ * `-t` <HOST>:
+ HTTP server listen address, defaults to `127.0.0.1`.
+
+ * `-p` <PORT>:
+ HTTP server listen port, defaults to `8080`.
+
+ * `-v`:
+ Show program name, version and exit.
+
+ * `-h`:
+ Show help message and exit.
+
+## ARGUMENTS
+
+ * <DOCROOT>:
+ HTTP server document root.
+
+## BUGS
+
+Please report any issues to: <https://github.com/blogc/blogc>
+
+## AUTHOR
+
+Rafael G. Martins &lt;<rafael@rafaelmartins.eng.br>&gt;
+
+## SEE ALSO
+
+blogc(1)
diff --git a/man/index.txt b/man/index.txt
index 7f78f2a..40a80d6 100644
--- a/man/index.txt
+++ b/man/index.txt
@@ -1,6 +1,7 @@
# manuals
blogc(1) blogc.1.ronn
blogc-git-receiver(1) blogc-git-receiver.1.ronn
+blogc-runserver(1) blogc-runserver.1.ronn
blogc-source(7) blogc-source.7.ronn
blogc-template(7) blogc-template.7.ronn