diff options
| author | Paul Buetow <paul@buetow.org> | 2022-02-19 23:02:51 +0000 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2022-02-20 10:18:39 +0000 |
| commit | 38abc2ecb3cbc70aeb11d9d390d9a6ef53478a23 (patch) | |
| tree | 47b93bf8e569886f123dcf6b8d62167f7f31b0f1 /docs | |
| parent | 6feae6c65217e8b82c33d3fd4c15be09293ebf9f (diff) | |
ShellCheck OK now. Also, some refactorings.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/photoalbum.1 | 184 | ||||
| -rw-r--r-- | docs/photoalbum.pod | 58 | ||||
| -rw-r--r-- | docs/photoalbum.txt | 45 |
3 files changed, 0 insertions, 287 deletions
diff --git a/docs/photoalbum.1 b/docs/photoalbum.1 deleted file mode 100644 index 146d2d4..0000000 --- a/docs/photoalbum.1 +++ /dev/null @@ -1,184 +0,0 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) -.\" -.\" Standard preamble: -.\" ======================================================================== -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Vb \" Begin verbatim text -.ft CW -.nf -.ne \\$1 -.. -.de Ve \" End verbatim text -.ft R -.fi -.. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' -.ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" -. ds C` "" -. ds C' "" -'br\} -.el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' -. ds C` -. ds C' -'br\} -.\" -.\" Escape single quotes in literal strings from groff's Unicode transform. -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" -.\" If the F register is >0, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index -.\" entries marked with X<> in POD. Of course, you'll have to process the -.\" output yourself in some meaningful fashion. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX -.. -.nr rF 0 -.if \n(.g .if rF .nr rF 1 -.if (\n(rF:(\n(.g==0)) \{\ -. if \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" -.. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 -. \} -. \} -.\} -.rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C -.\" ======================================================================== -.\" -.IX Title "PHOTOALBUM 1" -.TH PHOTOALBUM 1 "2022-02-05" "photoalbum 0.4.5" "User Commands" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.if n .ad l -.nh -.SH "NAME" -photoalbum \- photoalbum is a minimal bash script for linux to generate static web photo albums. -.SH "SYNOPSIS" -.IX Header "SYNOPSIS" -photoalbum clean|generate|version|recursive:DIR [rcfile] -photoalbum makemake -.IP "clean" 4 -.IX Item "clean" -Cleans up the working space -.IP "version" 4 -.IX Item "version" -Prints out the version -.IP "generate" 4 -.IX Item "generate" -Generates the static photoalbum -.IP "makemake" 4 -.IX Item "makemake" -Creates a Makefile and photoalbumrc in the current working directory. -.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. -.PP -* Copy all images wanted to the incoming folder (see config file) -.PP -* Run 'photoalbum generate' -.PP -* Distribute the ./dist directory -.PP -* Clean the mess up with 'photoalbum clean' -.PP -It is possible to specify a custom rcfile path too. -.PP -\fI\s-1HTML TEMPLATES\s0\fR -.IX Subsection "HTML TEMPLATES" -.PP -Go to the templates directory and edit them as wished. -.SH "LICENSE" -.IX Header "LICENSE" -See package description or project website. -.SH "AUTHOR" -.IX Header "AUTHOR" -Paul Buetow \- <http://buetow.org> diff --git a/docs/photoalbum.pod b/docs/photoalbum.pod deleted file mode 100644 index 9c55dd7..0000000 --- a/docs/photoalbum.pod +++ /dev/null @@ -1,58 +0,0 @@ -=head1 NAME - -photoalbum - photoalbum is a minimal bash script for linux to generate static web photo albums. - -=head1 SYNOPSIS - -photoalbum clean|generate|version|recursive:DIR [rcfile] -photoalbum makemake - -=over - -=item clean - -Cleans up the working space - -=item version - -Prints out the version - -=item generate - -Generates the static photoalbum - -=item makemake - -Creates a Makefile and photoalbumrc in the current working directory. - -=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. - -* Copy all images wanted to the incoming folder (see config file) - -* Run 'photoalbum generate' - -* Distribute the ./dist directory - -* 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. - -=head1 LICENSE - -See package description or project website. - -=head1 AUTHOR - -Paul Buetow - <http://buetow.org> - -=cut diff --git a/docs/photoalbum.txt b/docs/photoalbum.txt deleted file mode 100644 index 56d7806..0000000 --- a/docs/photoalbum.txt +++ /dev/null @@ -1,45 +0,0 @@ -NAME - photoalbum - photoalbum is a minimal bash script for linux to generate - static web photo albums. - -SYNOPSIS - photoalbum clean|generate|version|recursive:DIR [rcfile] photoalbum - makemake - - clean - Cleans up the working space - - version - Prints out the version - - generate - Generates the static photoalbum - - makemake - Creates a Makefile and photoalbumrc in the current working - directory. - - RCFILE - TUTORIAL - * See if /etc/default/photoalbum fits your needs. If not, copy - /etc/default/photoalbum to ~/.photoalbumrc in order to customize it. - - * Copy all images wanted to the incoming folder (see config file) - - * Run 'photoalbum generate' - - * Distribute the ./dist directory - - * 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. - -LICENSE - See package description or project website. - -AUTHOR - Paul Buetow - <http://buetow.org> - |
