Files
elog/man/elogd.8
T
2003-03-26 07:55:17 +00:00

115 lines
2.9 KiB
Plaintext
Executable File

.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH ELOGD 8 "January 15, 2003"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
elogd \- web server program for Electronic Logbook ELOG
.SH SYNOPSIS
.sp
\fBelog\fR [ \fB-a \fIpassword\fB\fR ] [ \fB-c \fIfile\fB\fR ] [ \fB-D\fR ]
[ \fB-d \fIdirectory\fB\fR ] [ \fB-f \fIfile\fB\fR ] [ \fB-k\fR ]
[ \fB-l \fIlogbook\fB\fR ] [ \fB-p \fIport\fB\fR ] [ \fB-r \fIpassword\fB\fR ]
[ \fB-s \fIdirectory\fB\fR ] [ \fB-v\fR ] [ \fB-w \fIpassword\fB\fR ]
.SH DESCRIPTION
.PP
The Electronic Logbook
.B ELOG
can be used to store and retrieve messages through a Web interface. Depending
on the configuration, the
.B ELOG
system can host one or more logbooks which are stored in separate sections on
the server.
.B elogd
is the daemon program serving as a simple web server for the
.B ELOG
system.
.SH OPTIONS
\fBelogd\fP accepts the following options:
.TP
.BI -a " password"
create/overwrite admin password in config file
.TP
.BI -c " file"
specify configuration file
.TP
.BR -D
become a daemon
.TP
.BI -d " directory"
specify logbook root directory
.TP
.BI -f " file"
specify PID file
.TP
.BI -h " host"
host where
.B elogd
will run
.TP
.BR -k
do not use keep\-alive
.TP
.BI -l " logbook"
specify logbook for `\-r' and `\-w' commands
.TP
.BI -p " port"
port where
.B elogd
will run
.TP
.BI -r " password"
create/overwrite read password in config file
.TP
.BI -s " directory"
specify resource directory (eg. themes, icons)
.TP
.BR -v
debugging output
.TP
.BI -w " password"
create/overwrite write password in config file
.SH SEE ALSO
.BR elog (1).
.PP
The full documentation for
.B ELOG
is maintained as an html manual. You can reach it from the package document
directory.
.SH WARNINGS
.B elogd
is run under a seperate user/group
.I elog
, by default. You might
change it via
.I Usr
and
.I Grp
options in configuration file. The configuration and stylesheet files should
be readable by that user.
.PP
Passwords are transferred over the network in plain text and therefore, are not
secure. Although the
.B elogd
program does not support secure connections over SSL directly, an SSL
encryption wrapper like
.I stunnel
might be used for this purpose.
.SH AUTHOR
Written by Stefan Ritt <stefan.ritt@psi.ch>.
.PP
This manual page was written by Recai Oktas <roktas@omu.edu.tr>, for the Debian
GNU/Linux system (but may be used by others).