1xtide(1) General Commands Manual xtide(1)
2
6 xtide - Harmonic tide clock and tide predictor (interactive client)
7
9 xtide [-aa y|n] [-b ``YYYY-MM-DD HH:MM''] [-bc color] [-bg color] [-cb
10 y|n] [-cw pixels] [-dc color] [-Dc color] [-df ``format-string'']
11 [-display ``X display''] [-ec color] [-el y|n] [-em pSsMm] [-fc color]
12 [-fe y|n] [-fg color] [-fn font] [-ga aspect] [-geometry
13 ``±XOFF±YOFF''] [-gh pixels] [-gl longitude] [-gt y|n] [-gw pixels]
14 [-hf ``format-string''] [-in y|n] [-l ``location name''] [-lw pixels]
15 [-m a|g|k|m|p|r] [-mc color] [-Mc color] [-nc color] [-nf y|n] [-tf
16 ``format-string''] [-tl y|n] [-u ft|m] [-v] [-z y|n]
17
19 XTide is a package that provides tide and current predictions in a wide
20 variety of formats. Graphs, text listings, and calendars can be gener‐
21 ated, or a tide clock can be provided on your desktop.
22 XTide can work with X-windows, plain text terminals, or the web. This
24 is accomplished with three separate programs: the interactive interface
25 (xtide), the non-interactive or command line interface (tide), and the
26 web interface (xttpd).
27 xtide is the interactive X-windows client for XTide 2. Although in
29 reality it accepts many command line options, you should not need to
30 use them; everything can be done interactively. Just run xtide and
31 point and click your way to whatever you need. If you get stuck, click
32 on a `?' button for on-line help.
33 For a complete discussion of the command line options and a detailed
35 explanation of the interactive interface, please see the verbose docu‐
36 mentation at http://www.flaterco.com/xtide/.
37
39 Unless a configuration file /etc/xtide.conf is supplied, you must set
40 the environment variable HFILE_PATH to point to the harmonics files
41 that should have been installed along with the xtide program. Example:
42 export HFILE_PATH=/usr/local/share/xtide/harmonics.tcd
43 If a configuration file is used, the first line should consist of the
44 colon-separated list of harmonics files (e.g. the HFILE_PATH line above
45 without the "export HFILE_PATH=" part). The environment variable takes
46 precedence over the configuration file.
47 If the optional World Vector Shoreline files have been installed, the
49 path to those files can be supplied in the WVS_DIR environment variable
50 or as the second line of the configuration file.
51 Set the environment variable XTIDE_DEFAULT_LOCATION to the name of your
53 favorite place if you want to skip the location-choosing step.
54
56 -aa y|n
57 Select whether or not to anti-alias tide graphs on true color
58 displays (default y). Turning this off can greatly improve per‐
59 formance on CPU-bound systems.
60 -b ``YYYY-MM-DD HH:MM''
62 Specify the begin (start) time for predictions using the ISO
63 8601 compliant format YYYY-MM-DD HH:MM, where hours range from
64 00 to 23. The timestamp is in the local time zone for the loca‐
65 tion, or in UTC if the -z setting is engaged. If clock mode is
66 selected or if no -b is supplied, the current time will be used.
67 -bc color
69 Background color of buttons (default gray80).
70 -bg color
72 Background color for text windows and location chooser (default
73 white).
74 -cb y|n
76 Select whether or not tide clocks should be created with buttons
77 (default n).
78 -cw pixels
80 Initial width for tide clocks (default 84 pixels). Note: Ini‐
81 tial clock height is the same as initial graph height.
82 -dc color
84 Daytime background color in tide graphs (default SkyBlue).
85 -Dc color
87 Color of datum line in tide graphs (default white).
88 -df ``format-string''
90 strftime(3) style format string for printing dates (default
91 %Y-%m-%d).
92 -display ``X display''
94 Specify the X display, e.g. "quake:0.0". This overrides the
95 DISPLAY environment variable.
96 -ec color
98 Foreground in tide graphs during outgoing tide (default Sea‐
99 Green).
100 -el y|n
102 Select whether or not to draw datum and middle-level lines in
103 tide graphs (default n).
104 -em pSsMm
106 Events to suppress (p = phase of moon, S = sunrise, s = sunset,
107 M = moonrise, m = moonset), or x to suppress none. E.g, to sup‐
108 press all sun and moon events, set eventmask to the value pSsMm.
109 -fc color
111 Foreground in tide graphs during incoming tide (default Blue).
112 -fe y|n
114 Select whether or not to prefer flat map to round globe location
115 chooser (default n).
116 -fg color
118 Color of text and other notations (default black).
119 -fn font
121 Font used for button labels and verbiage in text windows
122 (default as incoming from X11). The font used in graphs and
123 clocks cannot be changed.
124 -ga aspect
126 Initial aspect for tide graphs and clocks (default 1.0). This
127 controls not the width or height of the window but rather the
128 relative scaling of the X and Y axes in the plot of the tide
129 curve.
130 -geometry ``±XOFF±YOFF''
132 Specify a position for the window corresponding to the first use
133 of -l. (Width and height are controlled by different settings.)
134 -gh pixels
136 Initial height for tide graphs and clocks (default 312 pixels).
137 -gl longitude
139 Initial center longitude for location chooser. Valid values are
140 -180 -150 -120 -90 -60 -30 0 30 60 90 120 150 and 360. 360 (the
141 default) will pick the longitude with the most tide stations.
142 -gt y|n
144 Select whether or not to label tenths of units in tide graphs
145 (default n).
146 -gw pixels
148 Initial width for tide graphs (default 960 pixels).
149 -hf ``format-string''
151 strftime(3) style format string for printing hour labels on time
152 axis (default %l).
153 -in y|n
155 Select whether or not to use inferred values for some con‐
156 stituents (default n). For expert use only.
157 -l ``location name''
159 Specify a location for tide predictions. When given to the
160 interactive client, this causes it to start a tide clock for the
161 specified location instead of launching a location chooser on
162 startup. This is useful for starting a tide clock automatically
163 when you log on. Multiple uses of -l will result in multiple
164 tide clocks.
165 -lw pixels
167 Width for lines in tide graphs with -nf (default 2.5 pixels).
168 -m a|g|k|m|p|r
170 Specify mode to be about, graph, clock, medium rare, plain, or
171 raw. The default is clock.
172 -mc color
174 Color of mark line in graphs and of location dots on the spin‐
175 ning globe (default red).
176 -Mc color
178 Color of middle-level line in tide graphs (default yellow).
179 -nc color
181 Nighttime background color in tide graphs (default DeepSkyBlue).
182 -nf y|n
184 Select whether or not to draw tide graphs as line graphs
185 (default n).
186 -tf ``format-string''
188 strftime(3) style format string for printing times (default
189 %l:%M %p %Z).
190 -tl y|n
192 Select whether or not to draw depth lines on top of the tide
193 graph (default n).
194 -u ft|m
196 Preferred units of length (default no preference).
197 -v Print version string and exit.
199 -z y|n Select whether or not to coerce all time zones to UTC (default
201 n).
202
204 tide(1), xttpd(8), http://www.flaterco.com/xtide/.
205XTide 2 2008-01-18 xtide(1)