summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/photoalbum.18
-rw-r--r--docs/photoalbum.pod6
-rw-r--r--docs/photoalbum.txt5
3 files changed, 15 insertions, 4 deletions
diff --git a/docs/photoalbum.1 b/docs/photoalbum.1
index 3673404..cddbf32 100644
--- a/docs/photoalbum.1
+++ b/docs/photoalbum.1
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "PHOTOALBUM 1"
-.TH PHOTOALBUM 1 "2013-12-29" "photoalbum 0.2.3" "User Commands"
+.TH PHOTOALBUM 1 "2014-02-16" "photoalbum 0.2.3" "User Commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -133,7 +133,7 @@
photoalbum \- photoalbum is a minimal bash script for linux to generate static web photo albums.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
-photoalbum [clean|init|version|generate|all]
+photoalbum clean|init|version|generate|all [rcfile]
.IP "clean" 4
.IX Item "clean"
Cleans up the working space
@@ -149,6 +149,8 @@ Generates the static photoalbum
.IP "all" 4
.IX Item "all"
This just runs 'clean init generate' right after another.
+.SS "\s-1RCFILE\s0"
+.IX Subsection "RCFILE"
.SS "\s-1TUTORIAL\s0"
.IX Subsection "TUTORIAL"
* See if /etc/default/photoalbum fits your needs. If not, copy /etc/default/photoalbum to ~/.photoalbumrc in order to customize it.
@@ -163,6 +165,8 @@ This just runs 'clean init generate' right after another.
.PP
* Clean the mess up with 'photoalbum clean'
.PP
+It is possible to specify a custom rcfile path too.
+.PP
\fI\s-1HTML\s0 \s-1TEMPLATES\s0\fR
.IX Subsection "HTML TEMPLATES"
.PP
diff --git a/docs/photoalbum.pod b/docs/photoalbum.pod
index a56fe3b..791de48 100644
--- a/docs/photoalbum.pod
+++ b/docs/photoalbum.pod
@@ -4,7 +4,7 @@ photoalbum - photoalbum is a minimal bash script for linux to generate static we
=head1 SYNOPSIS
-photoalbum [clean|init|version|generate|all]
+photoalbum clean|init|version|generate|all [rcfile]
=over
@@ -30,6 +30,8 @@ This just runs 'clean init generate' right after another.
=back
+=head2 RCFILE
+
=head2 TUTORIAL
* See if /etc/default/photoalbum fits your needs. If not, copy /etc/default/photoalbum to ~/.photoalbumrc in order to customize it.
@@ -44,6 +46,8 @@ This just runs 'clean init generate' right after another.
* Clean the mess up with 'photoalbum clean'
+It is possible to specify a custom rcfile path too.
+
=head3 HTML TEMPLATES
Go to the templates directory and edit them as wished.
diff --git a/docs/photoalbum.txt b/docs/photoalbum.txt
index 315b86b..fbb2d32 100644
--- a/docs/photoalbum.txt
+++ b/docs/photoalbum.txt
@@ -3,7 +3,7 @@ NAME
static web photo albums.
SYNOPSIS
- photoalbum [clean|init|version|generate|all]
+ photoalbum clean|init|version|generate|all [rcfile]
clean
Cleans up the working space
@@ -19,6 +19,7 @@ SYNOPSIS
all This just runs 'clean init generate' right after another.
+ RCFILE
TUTORIAL
* See if /etc/default/photoalbum fits your needs. If not, copy
/etc/default/photoalbum to ~/.photoalbumrc in order to customize it.
@@ -33,6 +34,8 @@ SYNOPSIS
* Clean the mess up with 'photoalbum clean'
+ It is possible to specify a custom rcfile path too.
+
HTML TEMPLATES
Go to the templates directory and edit them as wished.