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''] [-cw pixels] [-dc color] [-Dc color]
10 [-df ``format-string''] [-e ``YYYY-MM-DD HH:MM''] [-ec color] [-el y|n]
11 [-em pSsMm] [-f c|h|i|l|p|t] [-fc color] [-fg color] [-ga aspect] [-gh
12 pixels] [-gt y|n] [-gw pixels] [-hf ``format-string''] [-in y|n] [-l
13 ``location name''] [-lw pixels] [-m a|b|c|C|g|k|l|m|p|r|s] [-mc color]
14 [-Mc color] [-ml [-]N.NN(ft|m|kt)] [-nc color] [-nf y|n] [-o ``file‐
15 name''] [-ph mm] [-pm mm] [-pw mm] [-s ``HH:MM''] [-tf ``format-
16 string''] [-tl y|n] [-th characters] [-tw characters] [-u ft|m] [-v]
17 [-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 -cw pixels
55 Width for tide clocks (default 84 pixels). Note: Clock height
56 is the same as graph height.
57 -dc color
59 Daytime background color in tide graphs (default SkyBlue).
60 -Dc color
62 Color of datum line in tide graphs (default white).
63 -df ``format-string''
65 strftime(3) style format string for printing dates (default
66 %Y-%m-%d).
67 -e ``YYYY-MM-DD HH:MM''
69 Specify the end (stop) time for predictions in banner, calendar,
70 alt. calendar, medium rare, plain, raw, or stats mode. Does not
71 apply in graph and clock modes: the effective end time for
72 graph and clock modes is entirely determined by the start time
73 (-b), the width (-cw, -gw or -tw), and the aspect (-ga). The
74 format and time zone are the same as for -b. If no -e is sup‐
75 plied, the end time will be set to four days after the begin
76 time.
77 -ec color
79 Foreground in tide graphs during outgoing tide (default Sea‐
80 Green).
81 -el y|n
83 Select whether or not to draw datum and middle-level lines in
84 tide graphs (default n).
85 -em pSsMm
87 Events to suppress (p = phase of moon, S = sunrise, s = sunset,
88 M = moonrise, m = moonset), or x to suppress none. E.g, to sup‐
89 press all sun and moon events, set eventmask to the value pSsMm.
90 -f c|h|i|l|p|t
92 Specify the output format as CSV, HTML, iCalendar, LaTeX, PNG,
93 or text. The default is text.
94 -fc color
96 Foreground in tide graphs during incoming tide (default Blue).
97 -fg color
99 Color of text and other notations (default black).
100 -ga aspect
102 Aspect for tide graphs, clocks, and banners (default 1.0). This
103 controls not the width or height of the window but rather the
104 relative scaling of the X and Y axes in the plot of the tide
105 curve.
106 -gh pixels
108 Height for tide graphs and clocks (default 312 pixels).
109 -gt y|n
111 Select whether or not to label tenths of units in tide graphs
112 (default n).
113 -gw pixels
115 Width for tide graphs (default 960 pixels).
116 -hf ``format-string''
118 strftime(3) style format string for printing hour labels on time
119 axis (default %l).
120 -in y|n
122 Select whether or not to use inferred values for some con‐
123 stituents (default n). For expert use only.
124 -l ``location name''
126 Specify a location for tide predictions.
127 -lw pixels
129 Width for lines in tide graphs with -nf (default 2.5 pixels).
130 -m a|b|c|C|g|k|l|m|p|r|s
132 Specify mode to be about, banner, calendar, alt. calendar,
133 graph, clock, list, medium rare, plain, raw, or stats. The
134 default is plain.
135 -mc color
137 Color of mark line in graphs (default red).
138 -Mc color
140 Color of middle-level line in tide graphs (default yellow).
141 -ml [-]N.NN(ft|m|kt)
143 Specify the mark level to be used in predictions. The predic‐
144 tions will include the times when the tide level crosses the
145 mark. Not supported in clock mode. Example usage: -ml -0.25ft
146 -nc color
148 Nighttime background color in tide graphs (default DeepSkyBlue).
149 -nf y|n
151 Select whether or not to draw tide graphs as line graphs
152 (default n).
153 -o ``filename''
155 Redirect output to the specified file (appends).
156 -ph mm Nominal length of paper in LaTeX output (default 420 mm). This
158 need not match your actual paper; use "Shrink oversized pages"
159 in print options.
160 -pm mm Nominal width of top, bottom, left and right margins in LaTeX
162 output (default 10 mm). Actual width will depend on print scal‐
163 ing.
164 -pw mm Nominal width of paper in LaTeX output (default 297 mm). This
166 need not match your actual paper; use "Shrink oversized pages"
167 in print options.
168 -s ``HH:MM''
170 Specify the step interval, in hours and minutes, for raw or
171 medium rare mode predictions. The default is one hour.
172 -tf ``format-string''
174 strftime(3) style format string for printing times (default
175 %l:%M %p %Z).
176 -tl y|n
178 Select whether or not to draw depth lines on top of the tide
179 graph (default n).
180 -th characters
182 Height of ASCII graphs and clocks (default 24 characters).
183 -tw characters
185 Width of ASCII graphs, clocks, banners, and calendars (default
186 79 characters).
187 -u ft|m
189 Preferred units of length (default no preference).
190 -v Print version string and exit.
192 -z y|n Select whether or not to coerce all time zones to UTC (default
194 n).
195
197 xtide(1), xttpd(8), http://www.flaterco.com/xtide/.
198XTide 2 2008-02-05 tide(1)