help_text.txt 5.15 KB
Newer Older
1
2
# this is <help_text.txt>
# ============================================================================
3
4
5
6
# 
# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
# 
# stuploxx usage information
7
# parameter and options
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#
# ----
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version. 
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
# ----
# 
# REVISIONS and CHANGES 
#    18/03/2015   V1.0   Thomas Forbriger (thof)
#
# ----------------------------------------------------------------------------
#
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# v
# D
   [-v] [-D]
# device
   [-device dev]

# interactive
   [-interactive]
# hdevice
   [-hdevice dev]
# hcommand
   [-hcommand c]

# repeat
   [-repeat[=i]]
# repcmd
   [-repcmd c]

# lwts (not implemented)
   [-lwts l]
# chts (not implemented)
   [-chts h]
# lwtg (not implemented)
   [-lwtg l]
# spp (not implemented)
   [-spp v]
# lwpb (not implemented)
   [-lwpb l]
# chy
   [-chy h]
# lwyg (not implemented)
   [-lwyg l]
# lwys (not implemented)
   [-lwys l]

# title
# tstitle
   [-title t] [-tstitle v]
# labu
# labc
# labe
# labh
# labr
   [-labu] [-labc] [-labe] [-labh v] [-labr]
# npanels
   [-npanels n]
# datesep
   [-datesep s]
# lyd 
   [-lyd v]
# help
   or: stuploxx --help
# keys
   or: stuploxx --keys
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
-v           be verbose
-D           debug mode
-interactive interactive mode
-repeat[=i]  repeat plot with new data every i seconds.
-repcmd c    issue command string c in repeat more prior to each repetition
             this command will also be issued before re-reading data
             in interactive mode

-device dev  use PGPLOT device dev
-hdevice dev use PGPLOT device dev for hardcopies
-hcommand c  issue command string c after hardcopy

-title n     set title for plot to 'n'
-tstitle     set text scaling factor for title

-lwts l      set line width of time scale
-chts h      set character height of time scale
-lwtg l      set line width of time scale grid lines
             no time scale grid is plotted if option is not set

-spp p       set panel separation as a fraction of total plot height
-lwpb l      set line width of panel boxes
             no panel boxes are plotted if option is not set

-chy h       set character height of ordinate scale
             no ordinate scale is plotted if option is not set
-lyd d       set separation of ordinate unit label from graph box edge

-lwyg l      set line width for ordinate grid lines
             no ordinate grid lines are plotted if option is not set
-lwys l      set line width ordinate scale

-npanels n   plot at least n panels
-labu        underline graph label with appropriate line style
-labc        print graph label in appropriate colour
-labe        erase background of graph label
-labh h      set height of graph label as a fraction of panel height
-labr        reserve space for graph label; if plot range is set
             approrpiately, graph and label will not be overlapping;;
             this is useful together with chart stepping in
             particular

-datesep s   use s as separator between day, month, and year
 
file         SFF waveform data file name
t:n          can be used to select traces from file
p:n          places file data in panel n
ci:i         use color index i
lw:w         set line width to w
ls:s         set line style to s
n:n          set label to n
             the label may contain patterns that will be replaced
             (see below)
r:r,g,b      set color in rgb mode
h:h,l,s      set color in hls mode
f:format     select file format
s:min,max    set fixed limits for ordinate scale
sf:f         set limits for ordinate scale range to fraction f of the
             dataset's amplitude
cs:v         activate chart stepper function and step at fraction v
             of full plot range
ch:h         set chart stepping hysteresis as a fraction of range
u:units      set label for ordinate scale
a:a          additional annotation to graph; this will be appended
             to the graph label in ordinary line style; duplicate
             identical annotations will be discarded
A:a          additional annotation to graph; this will be prepended
             to the graph label in ordinary line style; duplicate
             identical annotations will be discarded

Patterns that may be used in data trace labels are:
%F     file name
%NF    number of file on command line
%NT    number of trace in file
%D     date of first sample
%T     time of first sample
%UT    time of first sample including microsecond
%S     station identifier
%C     channel identifier
%A     auxiliary identifier
%I     instrument identifier
%%     will be replaced by a literal '%'
# 
# ----- END OF help_text.txt -----