aboutsummaryrefslogtreecommitdiff
path: root/docs/revela.1.scd
diff options
context:
space:
mode:
authorYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-03-31 02:06:41 +0300
committerYaroslav de la Peña Smirnov <yps@yaroslavps.com>2022-03-31 02:06:41 +0300
commit3c7230c191ade30d5b9c8ef02a019ba42ab519f5 (patch)
tree7e85927e11ae604020c547cfe62c3aaa18cfe6f8 /docs/revela.1.scd
parentc251b0d5a905f19498e1d3312041b794e57fd2f8 (diff)
downloadrevela-3c7230c191ade30d5b9c8ef02a019ba42ab519f5.tar.gz
revela-3c7230c191ade30d5b9c8ef02a019ba42ab519f5.zip
Ready for packagingv0.1.0
* Documentation * make install/uninstall * roscha truthy fix * Other fixes/improvements
Diffstat (limited to 'docs/revela.1.scd')
-rw-r--r--docs/revela.1.scd65
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/revela.1.scd b/docs/revela.1.scd
new file mode 100644
index 0000000..a503668
--- /dev/null
+++ b/docs/revela.1.scd
@@ -0,0 +1,65 @@
+revela(1)
+
+# NAME
+
+revela - static image gallery generator.
+
+# SYNOPSIS
+
+*revela* [_OPTIONS_] <_-o OUTPUT DIR_>
+*revela-init*
+
+# DESCRIPTION
+
+*revela* is a static web image gallery generator. It optimizes images for the web
+and generates HTML files to create a photo/image gallery web site ready to be
+served by an HTML server.
+
+revela takes a directory with pictures, jinja-like templates and converts that
+into a static web gallery of said pictures organized into albums.
+
+The root of the input directory should contain at least the following
+directories and files:
+
+*content* - The directory with subdirectories that each contain pictures. Each
+subdirectory with pictures is considered an album. Each album should contain an
+album.ini file, for information on the format of this file read revela(5).
+
+*static* - Directory with 'static' directories and files to be copied as-is to the
+root of the output directory. Here you can put any static assets such as
+favicons, css, etc.
+
+*templates* - Here should go the templates for the website. There should be at
+least three files: _index.html_, _image.html_ and _album.html_. There can also
+be parent templates used by any of those three templates.
+
+*site.ini* - The configuration for the site, such as title, base url and image
+optimizations. For more information consult revela(5).
+
+*revela-init* is an interactive helper script that generates a _site.ini_ file
+and copies the default templates provided with revela in the working directory
+from where it was called.
+
+# OPTIONS
+
+*-i* _DIRECTORY_
+ Indicate the input directory. If not indicated it will default to the
+ current working dir.
+
+*-o* _DIRECTORY_
+ The output directory. This is the only required flag.
+
+*-n*
+ Dry run. Show which files would be copied and which html files rendered but
+ don't do anything.
+
+*-V*
+ Prints version information and exits.
+
+# SEE ALSO
+
+*revela*(5)
+
+# AUTHORS
+
+Yaroslav de la Peña Smirnov <yps@yaroslavps.com>.