Public/elog
1
0
Fork 0
mirror of https://gitea.psi.ch/ELOG/elog.git synced 2026-10-01 05:05:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial revision

Browse Source 
SVN revision: 341
This commit is contained in:
Stefan Ritt 2003-01-15 08:14:04 +00:00
parent 710c5451ba
commit 0ac5438d35
3 changed files with 260 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
man/elconv.1 Executable file
View File

@ -0,0 +1,56 @@
.\" 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 ELCONV 1 "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
elconv \- conversion program for ELOG messages
.SH SYNOPSIS
.sp
\fBelconv\fR [ \fB-v\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 elconv
is a support tool which converts the
.B ELOG
messages in old format to the current format. Basically you simply run
.B elconv
in the directory where all the `*.log' files live. If you have several
directories with log files, you run it once in each directory.
.SH OPTIONS
\fBelconv\fP accepts the following option:
.TP
.BR \-v
verbose output
.SH SEE ALSO
.BR elog (1),
.BR elogd (8).
.PP
The full documentation for
.B ELOG
is maintained as an html manual. You can reach it from the package document
directory.
.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).

104
man/elog.1 Executable file
View File

@ -0,0 +1,104 @@
.\" 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 ELOG 1 "January 15, 2002"
.\" 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
elog \- utility program for Electronic Logbook ELOG
.SH SYNOPSIS
.sp
\fBelog\fR \fB-a \fIattribute=value\fB\fR [ \fB-f \fIfile...\fB\fR ]
\fB-h \fIhost\fB\fR [ \fB-l \fIlogbook\fB\fR ] [ \fB-m \fItextfile\fB\fR ]
[ \fB-p \fIport\fB\fR ] [ \fB-r \fIid\fB\fR ] [ \fB-s \fIsubdir\fB\fR ]
[ \fB-u \fIusername\fB \fIpassword\fB\fR ] [ \fB-v\fR ]
[ \fB-w \fIpassword\fB\fR ] \fImessage\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 elog
is the standalone client program which can be used from the command line to
interact with the
.B ELOG
daemon (elogd). The
.B elog
message can either be submitted on the command line or in a file with the `\-m'
flag. For the former case, message with blanks must be enclosed in quotes.
Multiple attributes can be specified as well as several attachments. The
password must match the write password defined on the server. If user level
access is defined on the server (via the `Password file' option), a valid user
name / password pair must be specified with the `\-u' option.
.PP
The
.B elog
program makes it possible to submit logbook entries automatically by the system
or from scripts. In some shift logbooks this feature is used to enter alarm
messages automatically into the logbook.
.SH OPTIONS
\fBelog\fP accepts the following options:
.TP
.BI -a " attribute=value"
set attribute to value
.TP
.BI -f " file..."
attach files while submitting
.TP
.BI -h " host"
host where
.B elogd
is running
.TP
.BI -l " logbook"
name of logbook or experiment
.TP
.BI -m " textfile"
submit message from textfile
.TP
.BI -p " port"
port where
.B elogd
is running
.TP
.BI -r " id"
reply to existing message of id
.TP
.BI -s " dir"
directory where logbooks reside
.TP
.BI -u " username password"
username and password
.TP
.BR \-v
verbose output
.TP
.BI -w " password"
write password defined on server
.SH SEE ALSO
.BR elogd (8).
.PP
The full documentation for
.B ELOG
is maintained as an html manual. You can reach it from the package document
directory.
.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).

100
man/elogd.8 Executable file
View File

@ -0,0 +1,100 @@
.\" 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-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 -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
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).