.TH lug 1 "March 28, 2022" "lug version 3.00" "DekDoc scripts"
.SH NAME

lug - manage TeX Local User Group web pages

.SH Synopsis
lug [options] [lug-code] 

.SS Options

.B -h,--help
.RS
print short help and exit
.RE
.B -H,--Help
.RS
print full documentation via less and exit
.RE
.B -V,--version
.RS
print version and exit
.RE
.B -c,--clean
.RS
remove all files that can be re-created
.RE
.B -f,--full
.RS
re-create all files
.RE
.B -s,--sync[=STR]
.RS
synchronize the lug page at www.ntg.nl/STR
.RE
.RS
with the current directory; the default for STR is lug
.RE

.SH Description
lug can be used to to (re-)create the web pages of the LUG database. This script must be executed in its own directory. After the script has been executed, this directory will contain the web site for the [Electronic LUG Database](www.ntg.nl/lug). 

If you run lug for the first time, do so in a directory containging the script only; it wil then create all needed files and directories in it. 

Recreate all files: 

    $ lug --full

Apply corrections sent by email: 

    $ lug
    < paste the email contents to standard input >
    ^D

When people send new data by using the forms of the site, they do so by submitting the form, which causes an email with raw data to be sent to the administrator(s). 

An administrator should verify the password reported in the email and then cd to this directory, or to a copy of it on his own computer, and he should then run: 

    $ ./lug

lug waits for data, which it can be given by cut (from the email) and paste (to standard input). By ending the input with ^D, lug corrects the data in the directory `lugs' 

It is of course also possible to save the contents of the email into a file and then run: 

    $ ./lug <file

The administrator can make small correction to one country by giving the necessary input on the command line. For example, to change the email address of the treasurer of The Netherlands he can run: 

    $ ./lug
    code=nl
    femail=treasurer@ntg.nl
    ^D

Synchronize the website (www.ntg.nl/lug) with the current directory: 

    $ ./lug --sync

Of course, this action makes no sense if you are operating in the web directory itself. 

Or, for testing purposes, synchronize www.ntg.nl/lugtest: 

    $ ./lug --sync=lugtest

or, shorter: 

    $ ./lug -slugtest

Remove everything that can be regenerated: 

    $ ./lug --clean

This stores any changes made in the README.md file, the lugs.rb script, and the images en lugs directories in the script. After this operation only the script will be there, and you can simply restore everything by running it with the --full option. 

Regenerate everything:     $ ./lug --full

.SH Author
Wybo Dekker (wybo@ntg.nl) 

.SH Copyright
Released under the GNU General Public License (www.gnu.org\fIcopyleft\fRgpl.html)