add manpages
authorgc <gc>
Mon, 13 Jun 2005 20:34:46 +0000 (20:34 +0000)
committergc <gc>
Mon, 13 Jun 2005 20:34:46 +0000 (20:34 +0000)
doc/booh-backend.1 [new file with mode: 0644]
doc/booh.1 [new file with mode: 0644]
post-install.rb [new file with mode: 0644]

diff --git a/doc/booh-backend.1 b/doc/booh-backend.1
new file mode 100644 (file)
index 0000000..e7910e7
--- /dev/null
@@ -0,0 +1,106 @@
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program; if not, write to the Free Software
+.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+.\"
+
+.TH BOOH-BACKEND 1 "June 2005" "BOOH" "The booh web-album"
+
+.SH NAME
+booh-backend \- backend script of \fBbooh\fR, the static web-album generator
+
+.SH SYNOPSIS
+\fBbooh\fR [\fIOPTION\fR]...
+
+.SH DESCRIPTION
+\fBBooh\fR is a static Web-Album generator. It's a program whichl
+takes one or several series of photos and videos, and
+automatically build static web pages to browse them, creating
+thumbnails etc.
+.PP
+If you invoke \fBbooh-backend\fR from the command-line, this will
+launch the backend script allowing creating/generating an album.
+Contrast with \fBbooh\fR, which is the graphical user interface
+over the backend, the easiest way to create an album.
+
+.SH OPTIONS
+.TP
+\fB-h\fR, \fB--help\fR
+Get help message
+.TP
+\fB-V\fR, \fB--version\fR
+Print version and exit
+.TP
+\fB-n\fR, \fB--no-check\fR
+Don't check for needed external programs at startup
+.TP
+\fB-s\fR \fIDIR\fR, \fB--source\fR \fIDIR\fR
+Directory which contains original images/videos as files or subdirs
+.TP
+\fB-d\fR \fIDIR\fR, \fB--destination\fR \fIDIR\fR
+Directory which will contain the web-album
+.TP
+\fB-t\fR \fITHEME\fR, \fB--theme\fR \fITHEME\fR
+Select HTML theme to use
+.TP
+\fB-C\fR \fIFILE\fR, \fB--config\fR \fIFILE\fR
+File containing config listing images and videos within directories with captions
+.TP
+\fB-k\fR \fIFILE\fR, \fB--config-skel\fR \fIFILE\fR
+Filename where the script will output a config skeleton
+.TP
+\fB-M\fR \fIFILE\fR, \fB--merge-config\fR \fIFILE\fR
+File containing config listing, where to merge new images/videos from --source, and change theme info
+.TP
+\fB-O\fR \fIFILE\fR, \fB--merge-config-onedir\fR \fIFILE\fR
+File containing config listing, for merging the subdir specified with --dir
+.TP
+\fB-D\fR \fIDIR\fR, \fB--dir\fR \fIDIR\fR
+Directory for merge with --merge-config-onedir
+.TP
+\fB-u\fR \fIFILE\fR, \fB--use-config\fR \fIFILE\fR
+File containing config listing, where to change theme info
+.TP
+\fB-f\fR, \fB--force\fR
+Force generation of album even if the GUI marked some directories as already generated
+.TP
+\fB-S\fR \fISIZELIST\fR, \fB--sizes\fR \fISIZELIST\fR
+Specify the list of images sizes to use instead of all specified in the theme (this is a comma-separated list)
+.TP
+\fB-e\fR, \fB--empty-comments\fR
+Prefer empty comments over filename when creating new albums
+.TP
+\fB-m\fR \fINUM\fR, \fB--mproc\fR \fINUM\fR
+Specify the number of processors for multi-processors machines
+.TP
+\fB-g\fR, \fB--for-gui\fR
+Do the minimum work to be able to see the album under the GUI (don't generate all thumbnails)
+.TP
+\fB-v\fR \fINUM\fR, \fB--verbose-level\fR \fINUM\fR
+Set max verbosity level (0: errors, 1: warnings, 2: important messages, 3: other messages)
+.TP
+\fB-i\fR \fIPIPE\fR, \fB--info-pipe\fR \fIPIPE\fR
+Name a file where to write information about what's going on (used by the GUI)
+
+.SH AUTHOR
+Written by Guillaume Cottenceau.
+.br
+Visit official homepage: http://zarb.org/~gc/html/booh.html
+
+.SH SEE ALSO
+.BR booh-backend(1)
+
+.SH COPYRIGHT
+Copyright \(co 2005 Guillaume Cottenceau.
+.br
+This is Free Software; this software is licensed under the GPL version 2, as published by the Free Software Foundation.
+There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/doc/booh.1 b/doc/booh.1
new file mode 100644 (file)
index 0000000..c6c3046
--- /dev/null
@@ -0,0 +1,56 @@
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program; if not, write to the Free Software
+.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+.\"
+
+.TH BOOH 1 "June 2005" "BOOH" "The booh web-album"
+
+.SH NAME
+booh \- static web-album generator
+
+.SH SYNOPSIS
+\fBbooh\fR [\fIOPTION\fR]... [\fIFILENAME\fR]
+
+.SH DESCRIPTION
+\fBBooh\fR is a static Web-Album generator. It's a program which
+takes one or several series of photos and videos, and
+automatically build static web pages to browse them, creating
+thumbnails etc.
+.PP
+If you invoke \fBbooh\fR from the command-line, this will launch
+the graphical user interface, which is the most user friendly way
+of creating an album, editing etc. If you append a
+\fIFILENAME\fR, \fBbooh\fR will try to open this file when
+starting up.
+
+.SH OPTIONS
+.TP
+.BR -h , \ --help
+show command-line options summary
+.TP
+\fB-v \fINUM\fR, \fB--verbose \fINUM\fR
+Set max verbosity level (0: errors, 1: warnings, 2: important messages, 3: other messages)
+
+.SH AUTHOR
+Written by Guillaume Cottenceau.
+.br
+Visit official homepage: http://zarb.org/~gc/html/booh.html
+
+.SH SEE ALSO
+.BR booh-backend(1)
+
+.SH COPYRIGHT
+Copyright \(co 2005 Guillaume Cottenceau.
+.br
+This is Free Software; this software is licensed under the GPL version 2, as published by the Free Software Foundation.
+There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
diff --git a/post-install.rb b/post-install.rb
new file mode 100644 (file)
index 0000000..1f877a7
--- /dev/null
@@ -0,0 +1,6 @@
+# Install man pages.
+mandir = Config::CONFIG['mandir']
+system("mkdir -p #{mandir}/man1") or raise "Could not create man directory"
+Dir.glob("doc/*.1").each { |e|
+    system("install #{e} #{mandir}/man1") or raise "Could not install manpage"
+}