1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
|
.TH xttpd 8 "2002-10-03" "XTide 2"
.SH NAME
xttpd \- Harmonic tide clock and tide predictor (web server)
.SH SYNOPSIS
.B xttpd
[\fBport\fP]
.SH DESCRIPTION
XTide is a package that provides tide and current predictions in a wide
variety of formats. Graphs, text listings, and calendars can be generated,
or a tide clock can be provided on your desktop.
.LP
XTide can work with X-windows, plain text terminals, or the web. This is
accomplished with three separate programs: the interactive interface
(\fBxtide\fP), the non-interactive or command line interface
(\fBtide\fP), and the web interface (\fBxttpd\fP).
.LP
.B xttpd
is an XTide web server. It provides web-based access to XTide's tide
predictions by allowing a web browser to speak directly to the XTide
program in HTTP.
.B xttpd
can replace
.B httpd
or it can co-exist with one.
.LP
If you run
.B xttpd
with no command line arguments, it will assume that it is
replacing
.B httpd
and try to bind port 80. If you want it to co-exist with an
existing server, or if you do not have privilege to get port 80, give it
the port number as the first command line argument:
.RS
% xttpd 8080
.RE
You will then need to link it up as http://www.wherever.org:8080/ instead
of just http://www.wherever.org/, but otherwise, no damage done.
.B xttpd
will
try to set its UID to 'nobody' once the port is established, but will issue
a warning and continue with the default user ID if this fails.
.LP
For a complete
discussion of the command line options and a detailed explanation of the
XTide package, please see the verbose documentation at
.BR http://www.flaterco.com/xtide/ .
.SH CONFIGURATION
Unless a configuration file
.B /etc/xtide.conf
is supplied, you must set the environment variable
.B HFILE_PATH
to point to the harmonics
files that should have been installed along with the
.B xtide
program. Example:
.RS
export HFILE_PATH=/usr/local/share/xtide/harmonics.tcd
.RE
If a configuration file is used, the first line should consist of the
colon-separated list of harmonics files (e.g. the
.B HFILE_PATH
line above without the "export HFILE_PATH=" part).
The environment variable takes precedence over the configuration file.
.SH CONFIGURATION ON DEBIAN SYSTEMS
On
.B Debian
systems the web server
.B xttpd
may optionally be started at boot time by editing
.I /etc/init.d/xttpd
(setting the
.B PORT
variable and uncommenting out the line). Set the environment variable
.B XTTPD_FEEDBACK
in
.I /etc/init.d/xttpd
to change the mail feedback address.
.LP
Also, note that on Debian systems the tidal harmonics data file are stored in
.I /usr/share/xtide
instead of
.I /usr/local/share/xtide
as used above.
.SH "SEE ALSO"
.BR tide (1),
.BR xtide (1),
.BR http://www.flaterco.com/xtide/ .
.sp
|