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 tide 1 "2002-10-03" "XTide 2"
.SH NAME
tide \- Harmonic tide clock and tide predictor (command line client)
.SH SYNOPSIS
.B tide
[\fB-b ``YYYY-MM-DD HH:MM''\fP]
[\fB-e ``YYYY-MM-DD HH:MM''\fP]
[\fB-f h|p|t\fP]
[\fB-l ``location name''\fP]
[\fB-m b|c|C|g|l|m|p|r|s\fP]
[\fB-o ``filename''\fP]
[\fB-s ``HH:MM''\fP]
[\fB-v\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 tide
is the non-interactive command line client for XTide 2.
Only the most important switches are documented here.
For a complete
discussion, 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.
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.
.LP
Set the environment variable
.B XTIDE_DEFAULT_LOCATION
to the name of your favorite place if you want to skip the location-choosing
step.
.SH OPTIONS
.TP
.B -b ``YYYY-MM-DD HH:MM''
Specify the begin (start) time for predictions.
.TP
.B -e ``YYYY-MM-DD HH:MM''
Specify the end (stop) time for predictions.
.TP
.B -f h|p|t
Specify the output format as HTML, PNG, or text. The default is text.
Only calendar and list modes can do HTML; only graph mode can do PNG.
.TP
.B -l ``location name''
Specify a location for tide predictions.
.TP
.B -m b|c|C|g|l|m|p|r|s
Specify mode to be banner, calendar, alt. calendar, graph, list, medium rare, plain, raw, or
stats. The default is plain.
.TP
.B -o ``filename''
Redirect output to the specified file (appends).
.TP
.B -s ``HH:MM''
Specify the step interval, in hours and minutes, for raw
mode predictions. The default is one hour.
.TP
.B -v
Print version string and exit.
.SH "SEE ALSO"
.BR xtide (1),
.BR xttpd (8),
.BR http://www.flaterco.com/xtide/ .
.sp
|
