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''] [-gh pixels] [-gl longitude] [-gs d|l|s] [-gt y|n] [-gw
14 pixels] [-hf ``format-string''] [-in y|n] [-l ``location name''] [-lw
15 pixels] [-m a|g|k|m|p|r] [-mc color] [-Mc color] [-ml [-]N.NN(ft|m|kt)]
16 [-nc color] [-tc color] [-tf ``format-string''] [-tl y|n] [-to opacity]
17 [-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 -em pSsMm
108 Events to suppress (p = phase of moon, S = sunrise, s = sunset,
109 M = moonrise, m = moonset), or x to suppress none. E.g, to sup‐
110 press all sun and moon events, set eventmask to the value pSsMm.
111 -fc color
113 Foreground in tide graphs during incoming tide (default Blue).
114 -fe y|n
116 Select whether or not to prefer flat map to round globe location
117 chooser (default n).
118 -fg color
120 Color of text and other notations (default black).
121 -fn font
123 Font used for button labels and verbiage in text windows
124 (default as incoming from X11). The font used in graphs and
125 clocks cannot be changed.
126 -ga aspect
128 Initial aspect for tide graphs and clocks (default 1.0). This
129 controls not the width or height of the window but rather the
130 relative scaling of the X and Y axes in the plot of the tide
131 curve.
132 -geometry ``±XOFF±YOFF''
134 Specify a position for the window corresponding to the first use
135 of -l. (Width and height are controlled by different settings.)
136 -gh pixels
138 Initial height for tide graphs (default 312 pixels).
139 -gl longitude
141 Initial center longitude for location chooser. Valid values are
142 -180 -150 -120 -90 -60 -30 0 30 60 90 120 150 and 360. 360 (the
143 default) will pick the longitude with the most tide stations.
144 -gs d|l|s
146 Style of graphs and clocks. Valid values: d (default), l
147 (line), s (semitransparent).
148 -gt y|n
150 Select whether or not to label tenths of units in tide graphs
151 (default n).
152 -gw pixels
154 Initial width for tide graphs (default 960 pixels).
155 -hf ``format-string''
157 strftime(3) style format string for printing hour labels on time
158 axis (default %l).
159 -in y|n
161 Select whether or not to use inferred values for some con‐
162 stituents (default n). For expert use only.
163 -l ``location name''
165 Specify a location for tide predictions. When given to the
166 interactive client, this causes it to start a tide clock for the
167 specified location instead of launching a location chooser on
168 startup. This is useful for starting a tide clock automatically
169 when you log on. Multiple uses of -l will result in multiple
170 tide clocks.
171 -lw pixels
173 Width of line in graph styles l and s (default 2.5 pixels).
174 -m a|g|k|m|p|r
176 Specify mode to be about, graph, clock, medium rare, plain, or
177 raw. The default is clock.
178 -mc color
180 Color of mark line in graphs (default red).
181 -Mc color
183 Color of middle-level line in tide graphs (default yellow).
184 -ml [-]N.NN(ft|m|kt)
186 Specify an initial mark level to be used in prediction windows
187 launched from the command line. The predictions will include
188 the times when the tide level crosses the mark. The mark level
189 also can be specified or changed using the Options menu. Not
190 supported in clock mode. Does not affect windows that are
191 launched from the location chooser. Example usage: -ml -0.25ft
192 -nc color
194 Nighttime background color in tide graphs (default DeepSkyBlue).
195 -nf y|n
197 Select whether or not to draw tide graphs as line graphs
198 (default n).
199 -tc color
201 Color of dots indicating tide stations in the location chooser
202 (default red).
203 -tf ``format-string''
205 strftime(3) style format string for printing times (default
206 %l:%M %p %Z).
207 -tl y|n
209 Select whether or not to draw depth lines on top of the tide
210 graph (default n).
211 -to opacity
213 Opacity of the fill in graph style s (semitransparent) (default
214 0.65).
215 -u ft|m
217 Preferred units of length (default no preference).
218 -v Print version string and exit.
220 -z y|n Select whether or not to coerce all time zones to UTC (default
222 n).
223
225 tide(1), xttpd(8), http://www.flaterco.com/xtide/.
226XTide 2 2011-08-21 xtide(1)