1tide(1) General Commands Manual tide(1)
2
6 tide - Harmonic tide clock and tide predictor (command line client)
7
9 tide [-b ``YYYY-MM-DD HH:MM''] [-ch pixels] [-cw pixels] [-dc color]
10 [-Dc color] [-df ``format-string''] [-e ``YYYY-MM-DD HH:MM''] [-ec
11 color] [-el y|n] [-em pSsMm] [-f c|h|i|l|p|t|v] [-fc color] [-fg color]
12 [-ga aspect] [-gh pixels] [-gs d|l|s] [-gt y|n] [-gw pixels] [-hf
13 ``format-string''] [-in y|n] [-l ``location name''] [-lw pixels] [-m
14 a|b|c|C|g|k|l|m|p|r|s] [-mc color] [-Mc color] [-ml [-]N.NN(ft|m|kt)]
15 [-nc color] [-o ``filename''] [-ph mm] [-pm mm] [-pw mm] [-s ``HH:MM'']
16 [-tf ``format-string''] [-th characters] [-tl y|n] [-to opacity] [-tw
17 characters] [-u ft|m] [-v] [-z y|n]
18
20 XTide is a package that provides tide and current predictions in a wide
21 variety of formats. Graphs, text listings, and calendars can be gener‐
22 ated, or a tide clock can be provided on your desktop.
23 XTide can work with X-windows, plain text terminals, or the web. This
25 is accomplished with three separate programs: the interactive interface
26 (xtide), the non-interactive or command line interface (tide), and the
27 web interface (xttpd).
28 tide is the non-interactive command line client for XTide 2. For a
30 complete discussion, please see the verbose documentation at
31 http://www.flaterco.com/xtide/.
32
34 Unless a configuration file /etc/xtide.conf is supplied, you must set
35 the environment variable HFILE_PATH to point to the harmonics files
36 that should have been installed along with the xtide program. Example:
37 export HFILE_PATH=/usr/local/share/xtide/harmonics.tcd
38 If a configuration file is used, the first line should consist of the
39 colon-separated list of harmonics files (e.g. the HFILE_PATH line above
40 without the "export HFILE_PATH=" part). The environment variable takes
41 precedence over the configuration file.
42 Set the environment variable XTIDE_DEFAULT_LOCATION to the name of your
44 favorite place if you want to skip the location-choosing step.
45
47 -b ``YYYY-MM-DD HH:MM''
48 Specify the begin (start) time for predictions using the ISO
49 8601 compliant format YYYY-MM-DD HH:MM, where hours range from
50 00 to 23. The timestamp is in the local time zone for the loca‐
51 tion, or in UTC if the -z setting is engaged. If clock mode is
52 selected or if no -b is supplied, the current time will be used.
53 -ch pixels
55 Height for tide clocks (default 312 pixels).
56 -cw pixels
58 Width for tide clocks (default 84 pixels).
59 -dc color
61 Daytime background color in tide graphs (default SkyBlue).
62 -Dc color
64 Color of datum line in tide graphs (default white).
65 -df ``format-string''
67 strftime(3) style format string for printing dates (default
68 %Y-%m-%d).
69 -e ``YYYY-MM-DD HH:MM''
71 Specify the end (stop) time for predictions in banner, calendar,
72 alt. calendar, medium rare, plain, raw, or stats mode. Does not
73 apply in graph and clock modes: the effective end time for
74 graph and clock modes is entirely determined by the start time
75 (-b), the width (-cw, -gw or -tw), and the aspect (-ga). The
76 format and time zone are the same as for -b. If no -e is sup‐
77 plied, the end time will be set to four days after the begin
78 time.
79 -ec color
81 Foreground in tide graphs during outgoing tide (default Sea‐
82 Green).
83 -el y|n
85 Select whether or not to draw datum and middle-level lines in
86 tide graphs (default n).
87 -em pSsMm
89 Events to suppress (p = phase of moon, S = sunrise, s = sunset,
90 M = moonrise, m = moonset), or x to suppress none. E.g, to sup‐
91 press all sun and moon events, set eventmask to the value pSsMm.
92 -f c|h|i|l|p|t|v
94 Specify the output format as CSV, HTML, iCalendar, LaTeX, PNG,
95 text, or SVG. The default is text.
96 -fc color
98 Foreground in tide graphs during incoming tide (default Blue).
99 -fg color
101 Color of text and other notations (default black).
102 -ga aspect
104 Aspect for tide graphs, clocks, and banners (default 1.0). This
105 controls not the width or height of the window but rather the
106 relative scaling of the X and Y axes in the plot of the tide
107 curve.
108 -gh pixels
110 Height for tide graphs (default 312 pixels).
111 -gs d|l|s
113 Style of graphs and clocks. Valid values: d (default), l
114 (line), s (semitransparent).
115 -gt y|n
117 Select whether or not to label tenths of units in tide graphs
118 (default n).
119 -gw pixels
121 Width for tide graphs (default 960 pixels).
122 -hf ``format-string''
124 strftime(3) style format string for printing hour labels on time
125 axis (default %l).
126 -in y|n
128 Select whether or not to use inferred values for some con‐
129 stituents (default n). For expert use only.
130 -l ``location name''
132 Specify a location for tide predictions.
133 -lw pixels
135 Width of line in graph styles l and s (default 2.5 pixels).
136 -m a|b|c|C|g|k|l|m|p|r|s
138 Specify mode to be about, banner, calendar, alt. calendar,
139 graph, clock, list, medium rare, plain, raw, or stats. The
140 default is plain.
141 -mc color
143 Color of mark line in graphs (default red).
144 -Mc color
146 Color of middle-level line in tide graphs (default yellow).
147 -ml [-]N.NN(ft|m|kt)
149 Specify the mark level to be used in predictions. The predic‐
150 tions will include the times when the tide level crosses the
151 mark. Not supported in clock mode. Example usage: -ml -0.25ft
152 -nc color
154 Nighttime background color in tide graphs (default DeepSkyBlue).
155 -o ``filename''
157 Redirect output to the specified file (appends).
158 -ph mm Nominal length of paper in LaTeX output (default 420 mm). This
160 need not match your actual paper; use "Shrink oversized pages"
161 in print options.
162 -pm mm Nominal width of top, bottom, left and right margins in LaTeX
164 output (default 10 mm). Actual width will depend on print scal‐
165 ing.
166 -pw mm Nominal width of paper in LaTeX output (default 297 mm). This
168 need not match your actual paper; use "Shrink oversized pages"
169 in print options.
170 -s ``HH:MM''
172 Specify the step interval, in hours and minutes, for raw or
173 medium rare mode predictions. The default is one hour.
174 -tf ``format-string''
176 strftime(3) style format string for printing times (default
177 %l:%M %p %Z).
178 -th characters
180 Height of ASCII graphs and clocks (default 24 characters).
181 -tl y|n
183 Select whether or not to draw depth lines on top of the tide
184 graph (default n).
185 -to opacity
187 Opacity of the fill in graph style s (semitransparent) (default
188 0.65).
189 -tw characters
191 Width of ASCII graphs, clocks, banners, and calendars (default
192 79 characters).
193 -u ft|m
195 Preferred units of length (default no preference).
196 -v Print version string and exit.
198 -z y|n Select whether or not to coerce all time zones to UTC (default
200 n).
201
203 xtide(1), xttpd(8), http://www.flaterco.com/xtide/.
204XTide 2 2011-08-21 tide(1)