1xtide(1) General Commands Manual xtide(1)
2
6 xtide - Harmonic tide clock and tide predictor (interactive client)
7
9 xtide [-b ``YYYY-MM-DD HH:MM''] [-bc color] [-bg color] [-cb y|n] [-cc
10 color] [-ch pixels] [-cw pixels] [-dc color] [-Dc color] [-df ``format-
11 string''] [-display ``X display''] [-ec color] [-el y|n] [-em pSsMm]
12 [-fc color] [-fe y|n] [-fg color] [-fn font] [-ga aspect] [-geometry
13 ``±XOFF±YOFF''] [-gf font] [-gh pixels] [-gl longitude] [-gs d|l|s]
14 [-gt y|n] [-gw pixels] [-hf ``format-string''] [-in y|n] [-l ``location
15 name''] [-lw pixels] [-m a|g|k|m|p|r] [-mc color] [-Mc color] [-mf
16 font] [-ml [-]N.NN(ft|m|kt)] [-nc color] [-ou y|n] [-tc color] [-tf
17 ``format-string''] [-tl y|n] [-to opacity] [-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 xtide is the interactive X-windows client for XTide 2. Although in
30 reality it accepts many command line options, you should not need to
31 use them; everything can be done interactively. Just run xtide and
32 point and click your way to whatever you need. If you get stuck, click
33 on a `?' button for on-line help.
34 For a complete discussion of the command line options and a detailed
36 explanation of the interactive interface, please see the verbose docu‐
37 mentation at http://www.flaterco.com/xtide/.
38
40 Unless a configuration file /etc/xtide.conf is supplied, you must set
41 the environment variable HFILE_PATH to point to the harmonics files
42 that should have been installed along with the xtide program. Example:
43 export HFILE_PATH=/usr/local/share/xtide/harmonics.tcd
44 If a configuration file is used, the first line should consist of the
45 colon-separated list of harmonics files (e.g. the HFILE_PATH line above
46 without the "export HFILE_PATH=" part). The environment variable takes
47 precedence over the configuration file.
48 If the optional World Vector Shoreline files have been installed, the
50 path to those files can be supplied in the WVS_DIR environment variable
51 or as the second line of the configuration file.
52 Set the environment variable XTIDE_DEFAULT_LOCATION to the name of your
54 favorite place if you want to skip the location-choosing step.
55
57 -b ``YYYY-MM-DD HH:MM''
58 Specify the begin (start) time for predictions using the ISO
59 8601 compliant format YYYY-MM-DD HH:MM, where hours range from
60 00 to 23. The timestamp is in the local time zone for the loca‐
61 tion, or in UTC if the -z setting is engaged. If clock mode is
62 selected or if no -b is supplied, the current time will be used.
63 -bc color
65 Background color of buttons (default gray80).
66 -bg color
68 Background color for text windows and location chooser (default
69 white).
70 -cb y|n
72 Select whether or not tide clocks should be created with buttons
73 (default n).
74 -cc color
76 Color of dots indicating current stations in the location
77 chooser (default rgb:00/A0/00).
78 -ch pixels
80 Initial height for tide clocks (default 312 pixels).
81 -cw pixels
83 Initial width for tide clocks (default 84 pixels).
84 -dc color
86 Daytime background color in tide graphs (default SkyBlue).
87 -Dc color
89 Color of datum line in tide graphs (default white).
90 -df ``format-string''
92 strftime(3) style format string for printing dates (default
93 %Y-%m-%d).
94 -display ``X display''
96 Specify the X display, e.g. "quake:0.0". This overrides the
97 DISPLAY environment variable.
98 -ec color
100 Foreground in tide graphs during outgoing tide (default Sea‐
101 Green).
102 -el y|n
104 Select whether or not to draw datum and middle-level lines in
105 tide graphs (default n).
106 The National Ocean Service (NOS) defines both Mean Sea Level
108 (MSL) and Mean Tide Level (MTL) in terms of averages taken over
109 observations. The middle-level line is drawn at the midpoint of
110 the theoretical tidal range, which usually corresponds to the
111 mathematical mean level of the predictions. This approximates
112 both MSL and MTL, but, strictly speaking, is equivalent to nei‐
113 ther. Moreover, subordinate station offsets may shift the
114 actual mean so that it no longer falls at the midpoint of the
115 tidal range. The datum line is drawn at the zero level of the
116 predictions, which usually corresponds to the station's bench‐
117 mark, but this too can be rendered inaccurate by subordinate
118 station offsets.
119 -em pSsMm
121 Events to suppress (p = phase of moon, S = sunrise, s = sunset,
122 M = moonrise, m = moonset), or x to suppress none. E.g, to sup‐
123 press all sun and moon events, set eventmask to the value pSsMm.
124 -fc color
126 Foreground in tide graphs during incoming tide (default Blue).
127 -fe y|n
129 Select whether or not to prefer flat map to round globe location
130 chooser (default n).
131 -fg color
133 Color of text and other notations (default black).
134 -fn font
136 Font used for button labels and verbiage in text windows
137 (default as incoming from X11 or libXaw3dXft). See NOTES.
138 -ga aspect
140 Initial aspect for tide graphs and clocks (default 1.0). This
141 controls not the width or height of the window but rather the
142 relative scaling of the X and Y axes in the plot of the tide
143 curve.
144 -geometry ``±XOFF±YOFF''
146 Specify a position for the window corresponding to the first use
147 of -l. (Width and height are controlled by different settings.)
148 -gf font
150 Font used in graphs and clocks in interactive client (default
151 "embedded"). Does not affect SVG-format output. See NOTES.
152 -gh pixels
154 Initial height for tide graphs (default 312 pixels).
155 -gl longitude
157 Initial center longitude for location chooser. Valid values are
158 -180 -150 -120 -90 -60 -30 0 30 60 90 120 150 and 360. 360 (the
159 default) will pick the longitude with the most tide stations.
160 -gs d|l|s
162 Style of graphs and clocks. Valid values: d (default), l
163 (line), s (semitransparent).
164 -gt y|n
166 Select whether or not to label tenths of units in tide graphs
167 (default n).
168 -gw pixels
170 Initial width for tide graphs (default 960 pixels).
171 -hf ``format-string''
173 strftime(3) style format string for printing hour labels on time
174 axis (default %l).
175 -in y|n
177 Select whether or not to use inferred values for some con‐
178 stituents (default n). For expert use only.
179 -l ``location name''
181 Specify a location for tide predictions. When given to the
182 interactive client, this causes it to start a tide clock for the
183 specified location instead of launching a location chooser on
184 startup. This is useful for starting a tide clock automatically
185 when you log on. Multiple uses of -l will result in multiple
186 tide clocks.
187 -lw pixels
189 Width of line in graph styles l and s (default 2.5 pixels).
190 -m a|g|k|m|p|r
192 Specify mode to be about, graph, clock, medium rare, plain, or
193 raw. The default is clock.
194 -mc color
196 Color of mark line in graphs (default red).
197 -Mc color
199 Color of middle-level line in tide graphs (default yellow).
200 -mf font
202 Monospace font used for location list, text predictions, help
203 windows and about mode text (default "-misc-fixed-medium-r-nor‐
204 mal--13-100-100-100-c-70-iso8859-1" (without libXaw3dXft) or
205 "LiberationMono-12" (with libXaw3dXft)). See NOTES.
206 -ml [-]N.NN(ft|m|kt)
208 Specify an initial mark level to be used in prediction windows
209 launched from the command line. The predictions will include
210 the times when the tide level crosses the mark. The mark level
211 also can be specified or changed using the Options menu. Not
212 supported in clock mode. Does not affect windows that are
213 launched from the location chooser. Example usage: -ml -0.25ft
214 -nc color
216 Nighttime background color in tide graphs (default DeepSkyBlue).
217 -ou y|n
219 Select whether or not to print numbers with no ft/m/kt (default
220 n).
221 -tc color
223 Color of dots indicating tide stations in the location chooser
224 (default red).
225 -tf ``format-string''
227 strftime(3) style format string for printing times (default
228 %l:%M %p %Z).
229 -tl y|n
231 Select whether or not to draw depth lines on top of the tide
232 graph (default n).
233 -to opacity
235 Opacity of the fill in graph style s (semitransparent) (default
236 0.65).
237 -u ft|m
239 Preferred units of length (default no preference).
240 -v Print version string and exit.
242 -z y|n Select whether or not to coerce all time zones to UTC (default
244 n).
245
247 If XTide is built with Xaw3dXft, font names given to XTide must be in
248 fontconfig format (e.g., "Helvetica-10"), rather than the traditional
249 XLFD (e.g., "-*-helvetica-*-r-*-*-10-*-*-*-*-*-*-*"). Also, Xaw3dXft
250 does not return errors if there are problems with a font name; it just
251 loads a default font instead.
252
254 tide(1), xttpd(8), http://www.flaterco.com/xtide/.
255XTide 2 2014-05-04 xtide(1)