1xttpd(8)                    System Manager's Manual                   xttpd(8)
2
3
4

NAME

6       xttpd - Harmonic tide clock and tide predictor (web server)
7

SYNOPSIS

9       xttpd  [port]  [-dc  color]  [-Dc  color]  [-df ``format-string''] [-ec
10       color] [-el y|n] [-em pSsMm] [-fc color] [-fg color] [-ga aspect]  [-gh
11       pixels]  [-gt  y|n] [-gw pixels] [-hf ``format-string''] [-in y|n] [-lw
12       pixels] [-mc color] [-Mc color] [-nc color] [-nf  y|n]  [-tf  ``format-
13       string''] [-tl y|n] [-u ft|m] [-v] [-z y|n]
14

DESCRIPTION

16       XTide is a package that provides tide and current predictions in a wide
17       variety of formats. Graphs, text listings, and calendars can be  gener‐
18       ated, or a tide clock can be provided on your desktop.
19
20       XTide  can  work with X-windows, plain text terminals, or the web. This
21       is accomplished with three separate programs: the interactive interface
22       (xtide),  the non-interactive or command line interface (tide), and the
23       web interface (xttpd).
24
25       xttpd is an XTide web server. It provides web-based access  to  XTide's
26       tide  predictions  by  allowing  a web browser to speak directly to the
27       XTide program in HTTP.  xttpd can replace httpd or it can co-exist with
28       one.
29
30       If you run xttpd with no command line arguments, it will assume that it
31       is replacing httpd and try to bind port 80. If you want it to  co-exist
32       with  an  existing  server, or if you do not have privilege to get port
33       80, give it the port number as the first command line argument:
34              % xttpd 8080
35       You will then need  to  link  it  up  as  http://www.wherever.org:8080/
36       instead  of  just  http://www.wherever.org/,  but  otherwise, no damage
37       done.  Similarly, if you wish to bind a specific address, you can spec‐
38       ify that as the first argument:
39              % xttpd 127.0.0.2
40       If  you  need to specify both address and port number, separate the two
41       with a slash, like this:
42              % xttpd 127.0.0.2/8080
43
44       Once the port is established, xttpd will try to set its UID and GID  to
45       values  that  were  specified  at  compile time.  If it is unable to do
46       this, it will log failure messages to syslog  and  then  exit.   Conse‐
47       quently, if it is to be started by someone other than root, that user's
48       UID and GID must be configured at compile time.  Instructions for doing
49       this are available at http://www.flaterco.com/xtide/installation.html.
50
51       For  a  complete  discussion of the command line options and a detailed
52       explanation of the XTide package, please see the verbose  documentation
53       at http://www.flaterco.com/xtide/.
54

CONFIGURATION

56       Unless  a  configuration file /etc/xtide.conf is supplied, you must set
57       the environment variable HFILE_PATH to point  to  the  harmonics  files
58       that should have been installed along with the xtide program.  Example:
59              export HFILE_PATH=/usr/local/share/xtide/harmonics.tcd
60       If  a  configuration file is used, the first line should consist of the
61       colon-separated list of harmonics files (e.g. the HFILE_PATH line above
62       without the "export HFILE_PATH=" part).  The environment variable takes
63       precedence over the configuration file.
64
65       Set the environment variable XTTPD_FEEDBACK to change the mail feedback
66       address for xttpd.
67

OPTIONS

69       -dc color
70              Daytime background color in tide graphs (default SkyBlue).
71
72       -Dc color
73              Color of datum line in tide graphs (default white).
74
75       -df ``format-string''
76              strftime(3)  style  format  string  for  printing dates (default
77              %Y-%m-%d).
78
79       -ec color
80              Foreground in tide graphs during  outgoing  tide  (default  Sea‐
81              Green).
82
83       -el y|n
84              Select  whether  or  not to draw datum and middle-level lines in
85              tide graphs (default n).
86
87       -em pSsMm
88              Events to suppress (p = phase of moon, S = sunrise, s =  sunset,
89              M = moonrise, m = moonset), or x to suppress none.  E.g, to sup‐
90              press all sun and moon events, set eventmask to the value pSsMm.
91
92       -fc color
93              Foreground in tide graphs during incoming tide (default Blue).
94
95       -fg color
96              Color of text and other notations (default black).
97
98       -ga aspect
99              Aspect for tide graphs (default 1.0).   This  controls  not  the
100              width or height of the window but rather the relative scaling of
101              the X and Y axes in the plot of the tide curve.
102
103       -gh pixels
104              Height for tide graphs (default 312 pixels).
105
106       -gt y|n
107              Select whether or not to label tenths of units  in  tide  graphs
108              (default n).
109
110       -gw pixels
111              Width for tide graphs (default 960 pixels).
112
113       -hf ``format-string''
114              strftime(3) style format string for printing hour labels on time
115              axis (default %l).
116
117       -in y|n
118              Select whether or not to  use  inferred  values  for  some  con‐
119              stituents (default n).  For expert use only.
120
121       -lw pixels
122              Width for lines in tide graphs with -nf (default 2.5 pixels).
123
124       -mc color
125              Color of mark line in graphs (default red).
126
127       -Mc color
128              Color of middle-level line in tide graphs (default yellow).
129
130       -nc color
131              Nighttime background color in tide graphs (default DeepSkyBlue).
132
133       -nf y|n
134              Select  whether  or  not  to  draw  tide  graphs  as line graphs
135              (default n).
136
137       -tf ``format-string''
138              strftime(3) style format  string  for  printing  times  (default
139              %l:%M %p %Z).
140
141       -tl y|n
142              Select  whether  or  not  to draw depth lines on top of the tide
143              graph (default n).
144
145       -u ft|m
146              Preferred units of length (default no preference).
147
148       -v     Print version string and exit.
149
150       -z y|n Select whether or not to coerce all time zones to  UTC  (default
151              n).
152

SEE ALSO

154       tide(1), xtide(1), http://www.flaterco.com/xtide/.
155
156
157
158
159XTide 2                           2008-01-18                          xttpd(8)
Impressum