1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
|
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Survex Programs — Survex 1.4.17 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
<script src="_static/documentation_options.js?v=91e0adf2"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.htm" />
<link rel="search" title="Search" href="search.htm" />
<link rel="next" title="Survex data files" href="datafile.htm" />
<link rel="prev" title="Getting Started" href="getstart.htm" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="survex-programs">
<h1>Survex Programs<a class="headerlink" href="#survex-programs" title="Link to this heading">¶</a></h1>
<p>This section describes command-line use of Survex. Our aim is to make all
functionality available without needing to use the command line (though we
aren’t quite there currently - the main thing lacking is more complex use of
<code class="docutils literal notranslate"><span class="pre">extend</span></code>). We also aim to give access from the command line to any
functionality which it is useful to be able to use from scripts, so that
users who do like to use the command line can take full advantage of it.</p>
<section id="standard-options">
<h2>Standard Options<a class="headerlink" href="#standard-options" title="Link to this heading">¶</a></h2>
<p>All Survex programs support to the following command line options:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display option summary and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
<p>Tools which take a processed survey data file to read also provide a way to
specify the prefix of a sub-survey to restrict reading to:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-s</span></code>, <code class="docutils literal notranslate"><span class="pre">--survey=</span></code><cite>SURVEY</cite></dt><dd><p>Only load the sub-survey <cite>SURVEY</cite>.</p>
</dd>
</dl>
</section>
<section id="short-and-long-options">
<h2>Short and Long Options<a class="headerlink" href="#short-and-long-options" title="Link to this heading">¶</a></h2>
<p>Options have two forms: short (a dash followed by a single letter e.g. <code class="docutils literal notranslate"><span class="pre">cavern</span>
<span class="pre">-q</span></code>) and long (two dashes followed by one or more words e.g. <code class="docutils literal notranslate"><span class="pre">cavern</span>
<span class="pre">--quiet</span></code>). The long form is generally easier to remember, while the short
form is quicker to type. Options are often available in both forms, but more
obscure or potentially dangerous options may only have a long form.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Command line options are case sensitive, so <code class="docutils literal notranslate"><span class="pre">-B</span></code> and <code class="docutils literal notranslate"><span class="pre">-b</span></code>
are different (this didn’t used to be the case before Survex 0.90). Case
sensitivity doubles the number of available short options (and is also the
norm on UNIX-like platforms).</p>
</div>
</section>
<section id="filenames-on-the-command-line">
<h2>Filenames on the Command Line<a class="headerlink" href="#filenames-on-the-command-line" title="Link to this heading">¶</a></h2>
<p>Filenames with spaces can be processed (provided your operating system supports
them - UNIX does, and so do modern versions of Microsoft Windows). You need to
enclose the filename in quotes like so:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cavern "Spider Cave"
</pre></div>
</div>
<p>A file specified on the command line of any of the Survex suite of programs
will be looked for as specified. If it is not found, then the file is looked
for with the appropriate extension appended, so the command above will look
first for <code class="docutils literal notranslate"><span class="pre">Spider</span> <span class="pre">Cave</span></code>, then for <code class="docutils literal notranslate"><span class="pre">Spider</span> <span class="pre">Cave.svx</span></code>.</p>
</section>
<section id="command-reference">
<h2>Command Reference<a class="headerlink" href="#command-reference" title="Link to this heading">¶</a></h2>
<section id="aven">
<h3>aven<a class="headerlink" href="#aven" title="Link to this heading">¶</a></h3>
<section id="synopsis">
<h4>SYNOPSIS<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h4>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">aven</span></code> [–survey=<cite>SURVEY</cite>] [–print] <cite>SURVEY_FILE</cite></p>
</div></blockquote>
</section>
<section id="description">
<h4>DESCRIPTION<a class="headerlink" href="#description" title="Link to this heading">¶</a></h4>
<p>Aven displays processed cave surveys in a window and allows you to
manipulate the view.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">SURVEY_FILE</span></code> is an unprocessed survey data format which <code class="docutils literal notranslate"><span class="pre">cavern</span></code>
can process, then <code class="docutils literal notranslate"><span class="pre">aven</span></code> will run <code class="docutils literal notranslate"><span class="pre">cavern</span></code> on it, and if successful,
display the processed data. If there are any warnings and errors, it will
show a log window with the output with clickable links to open the affected
file at the problematic line.</p>
<p><code class="docutils literal notranslate"><span class="pre">SURVEY_FILE</span></code> can also be processed survey data - a Survex <code class="docutils literal notranslate"><span class="pre">.3d</span></code> file, a
Compass <code class="docutils literal notranslate"><span class="pre">.plt</span></code> file or a CMAP <code class="docutils literal notranslate"><span class="pre">.sht</span></code> file. It can also be a Survex
<code class="docutils literal notranslate"><span class="pre">.pos</span></code> file or a CMP <code class="docutils literal notranslate"><span class="pre">.una</span></code> or <code class="docutils literal notranslate"><span class="pre">.adj</span></code> file, but for these only
stations are shown, not any legs (for <code class="docutils literal notranslate"><span class="pre">.pos</span></code> this is because the format
only records station positions). (All Survex programs which read <code class="docutils literal notranslate"><span class="pre">.3d</span></code>
files can also transparently handle these formats.)</p>
<section id="on-screen-indicators">
<h5>On-Screen Indicators<a class="headerlink" href="#on-screen-indicators" title="Link to this heading">¶</a></h5>
<p>There is an auto-resizing scale bar along the bottom of the screen
which varies in length as you zoom in or out. You can left-button drag
on this to zoom, and right click gives a menu to select units or hide
the scale bar (to get it back go to the Control->Indicators menu from
the menu bar).</p>
<p>In the lower right corner is a compass indicator showing which way is North.
You can drag this to rotate the view; if while dragging you move the mouse
outside the compass the view snaps to 45° positions: N/NE/E/SE/S/SW/W/NW.
Right click gives menu to change the view to N/S/E/W, select units, or
hide the compass (to get it back go to the Control->Indicators menu from
the menu bar).</p>
<p>Just to the left of the compass is clino indicator showing the angle of tilt.
You can drag this to tilt the view; if while dragging you move the mouse
outside the clino the view snaps to 90° positions: plan/elevation/inverted
plan. Right click gives menu to change the view to plan/elevation, select
units, or hide the clino (to get it back go to the Control->Indicators menu
from the menu bar).</p>
<p>In the upper right is a colour key showing the correspondence between colour
and depth (by default - you can also colour by other criteria). Right click
gives a menu to choose what to colour by, select units, or hide the colour
key (to get it back go to the Control->Indicators menu from the menu bar).</p>
</section>
<section id="mouse-control">
<h5>Mouse Control<a class="headerlink" href="#mouse-control" title="Link to this heading">¶</a></h5>
<p>Using the mouse to move the cave will probably feel most natural. We suggest
you try each of these out after reading this section to get a feel for how they
work.</p>
<p>If you hold down the right button then the view is panned when you move the
mouse - it effectively feels like you are dragging the cave around.</p>
<p>If you hold down the left button, then the view is rotated as you move left or
right, and zoomed as you move up and down. If you hold down <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> while
dragging with the left mouse button, then moving up and down instead tilts the
view. Tilt goes 180 degrees from plan view through elevation view to a view
from directly below (upside down plan) - aven deliberately doesn’t allow going
beyond horizontal into an inverted view.</p>
<p>If your mouse has a middle button then holding it down and moving the mouse up
and down tilts the cave. Moving the mouse left and right has no effect.</p>
<p>And if you have a scrollwheel, this can be used to zoom in/out.</p>
<p>By default the mouse moves the cave, but if you press <code class="docutils literal notranslate"><span class="pre">Ctrl-R</span></code>, then the
mouse will move the viewpoint instead (i.e. everything will go in the opposite
direction). Apparently this feels more natural to some people.</p>
</section>
<section id="keyboard-control">
<h5>Keyboard Control<a class="headerlink" href="#keyboard-control" title="Link to this heading">¶</a></h5>
<p>As with mouse controls, a little experimentation should give a better
understanding of how these work.</p>
<p>All keyboard shortcuts have a corresponding menu items which should show the
keyboard shortcut - this provides a way within the application to see the
keyboard shortcut for a particular action.</p>
<p><code class="docutils literal notranslate"><span class="pre">Delete</span></code> is useful if you get lost! It resets the scale, position, and
rotation speed, so that the cave returns to the centre of the screen. There
are also keyboard controls to use</p>
<p><code class="docutils literal notranslate"><span class="pre">P</span></code> and <code class="docutils literal notranslate"><span class="pre">L</span></code> select Plan and eLevation respectively. Changing between plan
to elevation is animated to help you see where you are and how things relate.
This animation is automatically disabled on slow machines to avoid user
frustration. You can force skipping the animation by pressing the key again
during it, so a double press will always take you there quickly.</p>
<p><code class="docutils literal notranslate"><span class="pre">Space</span></code> toggles on and off automatic rotation about a vertical axis through
the current centre point (which is moved by panning the view or by selecting
a station or survey). <code class="docutils literal notranslate"><span class="pre">R</span></code> toggles the direction of auto-rotation. The speed
of auto-rotation can be controlled by <code class="docutils literal notranslate"><span class="pre">Z</span></code> and <code class="docutils literal notranslate"><span class="pre">X</span></code>.</p>
<p>Crosses and/or labels can be displayed at survey stations. <code class="docutils literal notranslate"><span class="pre">Ctrl-X</span></code> toggles
crosses and <code class="docutils literal notranslate"><span class="pre">Ctrl-N</span></code> station names. <code class="docutils literal notranslate"><span class="pre">Ctrl-L</span></code> toggles the display of survey
legs and <code class="docutils literal notranslate"><span class="pre">Ctrl-F</span></code> of surface survey legs.</p>
<p><code class="docutils literal notranslate"><span class="pre">Ctrl-G</span></code> toggles display of an auto-sizing grid.</p>
<p><code class="docutils literal notranslate"><span class="pre">Ctrl-B</span></code> toggles display of a bounding box.</p>
<p><code class="docutils literal notranslate"><span class="pre">O</span></code> toggles display of non-overlapping/all names. For a large survey turning
on overlapping names will make update rather slow.</p>
<p>Holding down <code class="docutils literal notranslate"><span class="pre">Shift</span></code> accelerates all the following movement keys:</p>
<p>The cursor keys pan the survey view (like dragging with the right mouse button).</p>
<p><code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> plus cursor keys rotate and tilt (like the mouse left button with
<code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> held down). <code class="docutils literal notranslate"><span class="pre">C</span></code>/<code class="docutils literal notranslate"><span class="pre">V</span></code> do the same as <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> plus cursor
left/right, while Apostrophe <code class="docutils literal notranslate"><span class="pre">'</span></code>, and Slash <code class="docutils literal notranslate"><span class="pre">/</span></code> do the same as <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code>
plus cursor up/down.</p>
<p><code class="docutils literal notranslate"><span class="pre">[</span></code> and <code class="docutils literal notranslate"><span class="pre">]</span></code> zoom out and in respectively.</p>
</section>
</section>
<section id="options">
<h4>OPTIONS<a class="headerlink" href="#options" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-p</span></code>, <code class="docutils literal notranslate"><span class="pre">--print</span></code></dt><dd><p>Load the specified file, open the print dialog to allow printing, then exit.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-s</span></code>, <code class="docutils literal notranslate"><span class="pre">--survey=</span></code><cite>SURVEY</cite></dt><dd><p>Only load the sub-survey <cite>SURVEY</cite>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display short help and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
</section>
</section>
<section id="cavern">
<h3>cavern<a class="headerlink" href="#cavern" title="Link to this heading">¶</a></h3>
<section id="id1">
<h4>SYNOPSIS<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h4>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">cavern</span></code> [<cite>OPTIONS</cite>] <cite>SURVEY_DATA_FILE</cite>…</p>
</div></blockquote>
</section>
<section id="id2">
<h4>DESCRIPTION<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">cavern</span></code> is the Survex data processing engine.</p>
<p><code class="docutils literal notranslate"><span class="pre">cavern</span></code> is a command line tool, but if you’re not a fan of working from the
command line you can open unprocessed survey data files with <code class="docutils literal notranslate"><span class="pre">aven</span></code> and it
will run <code class="docutils literal notranslate"><span class="pre">cavern</span></code> for you, and if successful, display the processed data. If
there are any warnings and errors, <code class="docutils literal notranslate"><span class="pre">aven</span></code> will show a log window with the
output with clickable links to open the affected file at the problematic line.</p>
<p>If multiple survey data files are listed on the command line, they
are processed in order from left to right. Settings are reset to
their defaults before processing each file.</p>
<p>Each <cite>SURVEY_DATA_FILE</cite> must be unprocessed survey data in a format
which Survex supports, either native format (<code class="docutils literal notranslate"><span class="pre">.svx</span></code>) or Compass format
(<code class="docutils literal notranslate"><span class="pre">.mak</span></code>, <code class="docutils literal notranslate"><span class="pre">.dat</span></code> or <code class="docutils literal notranslate"><span class="pre">.clp</span></code>), or Walls format (<code class="docutils literal notranslate"><span class="pre">.wpj</span></code> or <code class="docutils literal notranslate"><span class="pre">.srv</span></code>).</p>
<p>Support for Compass <code class="docutils literal notranslate"><span class="pre">.clp</span></code> was added in Survex 1.4.6; support for
Walls was added in Survex 1.4.9.</p>
</section>
<section id="id3">
<h4>OPTIONS<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-o</span></code>, <code class="docutils literal notranslate"><span class="pre">--output=</span></code><cite>OUTPUT</cite></dt><dd><p>Sets location for output files.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-q</span></code>, <code class="docutils literal notranslate"><span class="pre">--quiet</span></code></dt><dd><p>Only show a brief summary (<code class="docutils literal notranslate"><span class="pre">--quiet</span> <span class="pre">--quiet</span></code> or <code class="docutils literal notranslate"><span class="pre">-qq</span></code> will display
warnings and errors only).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-s</span></code>, <code class="docutils literal notranslate"><span class="pre">--no-auxiliary-files</span></code></dt><dd><p>do not create .err file.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-w</span></code>, <code class="docutils literal notranslate"><span class="pre">--warnings-are-errors</span></code></dt><dd><p>turn warnings into errors.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--log</span></code></dt><dd><p>Send screen output to a .log file.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-v</span></code>, <code class="docutils literal notranslate"><span class="pre">--3d-version=</span></code><cite>3D_VERSION</cite></dt><dd><p>Specify the 3d file format version to output. By default the
latest version is written, but you can override this to produce
a 3d file which can be read by software which doesn’t
understand the latest 3d file format version. Note that any
information which the specified format version didn’t support
will be omitted.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display short help and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
</section>
<section id="output">
<h4>OUTPUT<a class="headerlink" href="#output" title="Link to this heading">¶</a></h4>
<p>If there were no errors during processing, cavern produces two
output files, with the extensions <code class="docutils literal notranslate"><span class="pre">.3d</span></code> and <code class="docutils literal notranslate"><span class="pre">.err</span></code> (unless
<code class="docutils literal notranslate"><span class="pre">--no-auxiliary-files</span></code> is specified in which case only the <code class="docutils literal notranslate"><span class="pre">.3d</span></code>
file is produced).</p>
<p>These two files are always created with their respective extensions. By
default they are created in the current directory, with the same base filename
as the first <cite>SURVEY_DATA_FILE</cite> listed on the command line.</p>
<p>E.g. if you process the data file <code class="docutils literal notranslate"><span class="pre">entrance.svx</span></code> with the command
<code class="docutils literal notranslate"><span class="pre">cavern</span> <span class="pre">entrance</span></code> or <code class="docutils literal notranslate"><span class="pre">cavern</span> <span class="pre">entrance.svx</span></code> then the files <code class="docutils literal notranslate"><span class="pre">entrance.3d</span></code>
and <code class="docutils literal notranslate"><span class="pre">entrance.err</span></code> will be created.</p>
<p>You can change the directory and/or base filename using the <code class="docutils literal notranslate"><span class="pre">--output</span></code>
command line option. If you specify a directory then output files will
go there instead of the current directory, but still use the basename
of the first <cite>SURVEY_DATA_FILE</cite>. If you specify a filename which is not a
directory (note that it doesn’t need to actually exist as a file) then the
directory this file is in is used, and also the basename of the filename
is used instead of the basename of the first <cite>SURVEY_DATA_FILE</cite>.</p>
<p>Details of the output files:</p>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">.3d</span></code></dt><dd><p>This is a binary file format containing the adjusted survey data and
associated meta data.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">.err</span></code></dt><dd><p>This is a text file which contains statistics about each traverse in the
survey which is part of a loop. It includes various statistics for each
traverse:</p>
<dl class="simple">
<dt>Original length</dt><dd><p>This is the measured length of the traverse (for a “normal” or “diving”
survey this is the sum of the tape readings after applying calibration
corrections).</p>
</dd>
<dt>Number of legs</dt><dd><p>The number of survey legs in the traverse</p>
</dd>
<dt>Moved</dt><dd><p>How much one end of the traverse moved by relative to the other after
loop closure</p>
</dd>
<dt>Moved per leg</dt><dd><p><cite>Moved</cite> / <cite>Number of legs</cite></p>
</dd>
<dt>Percentage error</dt><dd><p>(<cite>Moved</cite> / <cite>Original length</cite>) as a percentage. This seems to be a
popular measure of how good or bad a misclosure is, but it’s a
problematic one because a longer traverse will naturally tend to
have a lower percentage error so you can’t just compare values
between traverses. We recommend using the <cite>E</cite>, <cite>H</cite> and <cite>V</cite> values
instead.</p>
</dd>
<dt>Error (<cite>E</cite>)</dt><dd><p>This isn’t labelled in the <cite>.err</cite> file but is the value on a line by
itself. In <code class="docutils literal notranslate"><span class="pre">aven</span></code> it’s the value used by <cite>Colour by Error</cite>. It
is <cite>Moved</cite> divided by the standard deviation for the traverse based on
the standard errors specified for the instruments. This tells us how
plausible it is that the misclosure is just due to random errors. It
is a number of standard deviations, so the <a class="reference external" href="https://en.wikipedia.org/wiki/68%E2%80%9395%E2%80%9399.7_rule">68-95-99.7 rule</a>
applies - e.g. approximately 99.7% of traverses should have a value of
3.0 or less (assuming the specified instrument standard deviations are
realistic).</p>
</dd>
<dt>Horizontal Error (<cite>H</cite>)</dt><dd><p>This is like <cite>E</cite> but only considers the horizontal component. In
<code class="docutils literal notranslate"><span class="pre">aven</span></code> it’s the value used by <cite>Colour by Horizontal Error</cite>. You
can identify suspect traverses by looking at <cite>E</cite> and then compare
<cite>H</cite> and <cite>V</cite> to see what sort of blunder might explain the misclosure.
For example, if <cite>H</cite> is small but <cite>V</cite> is large it could be a clino reading
or plumb with an incorrect sign, or a tape blunder on a plumbed leg; if
<cite>H</cite> is large but <cite>V</cite> is small it could be a compass blunder, or a tape
blunder of a nearly-flat leg.</p>
</dd>
<dt>Vertical Error (<cite>V</cite>)</dt><dd><p>This is like <cite>E</cite> but only considers the vertical component. In
<code class="docutils literal notranslate"><span class="pre">aven</span></code> it’s the value used by <cite>Colour by Vertical Error</cite>.</p>
</dd>
</dl>
<p>This information is now also present in the <code class="docutils literal notranslate"><span class="pre">.3d</span></code> file so you can view the
survey coloured by these errors, but the <code class="docutils literal notranslate"><span class="pre">.err</span></code> file can
still be useful as you can sort it using <code class="docutils literal notranslate"><span class="pre">sorterr</span></code> to get a ranked list of
the sections of survey with the worst misclosure errors.</p>
</dd>
</dl>
<p>Cavern also reports a range of statistics at the end of a successful
run:</p>
<ul class="simple">
<li><p>The highest and lowest stations and the height difference between
them</p></li>
<li><p>The East-West and North-South ranges, and the Northernmost,
Southernmost, Easternmost, and Westernmost stations.</p></li>
<li><p>The total length of the survey (before and after adjustment). This
total excludes survey legs flagged as <code class="docutils literal notranslate"><span class="pre">SURFACE</span></code>, <code class="docutils literal notranslate"><span class="pre">DUPLICATE</span></code>, or
<code class="docutils literal notranslate"><span class="pre">SPLAY</span></code>.</p></li>
<li><p>The number of stations and legs. Note that a <code class="docutils literal notranslate"><span class="pre">*equate</span></code> is counted
as a leg in this statistic.</p></li>
<li><p>The number of each size of node in the network (where size is number of
connections to a station) i.e. a one node is the end of a dead-end traverse,
a two-node is a typical station in the middle of a traverse, a three-node is
a T-junction etc.</p></li>
<li><p>How long the processing took and how much CPU time was used.</p></li>
</ul>
<p>If you successfully processed your data by loading it into <code class="docutils literal notranslate"><span class="pre">aven</span></code> then you
can see this log output by using <code class="docutils literal notranslate"><span class="pre">File->Show</span> <span class="pre">Log</span></code> (also available as an icon
in the toolbar).</p>
<section id="error-messages">
<h5>Error Messages<a class="headerlink" href="#error-messages" title="Link to this heading">¶</a></h5>
<p>There are many different error messages that you can get when processing
data. Along with the error message, a location is reported. For an error
like “file not found” this only reports the filename, but usually it will
give the filename and line number of the offending line, and in many cases also
an offset or span within the line.</p>
<p>The format of the location data follows that used by the GCC compiler
so if your text editor can parse errors from GCC then you should be able to set
it to allow you to jump to the file and line of each error.</p>
<p>One common cause of errors and warnings are typing mistakes. Another is
your survey data not being all attached to fixed points (which is a warning
since Survex 1.4.10, but was an error prior to this; in this situation, Survex
will list at least one station in each piece of survey data which is not
connected).</p>
<p>We try to make error and warning messages self-explanatory, but welcome
feedback on cases where you get a message which seems unclear.</p>
<p>Generally you want to look at the first reported error first as there
can be a cascade effect where one error triggers another. Cavern will stop
after more than 50 errors. This usually indicates something like the incorrect
data order being specified and deluging the user with error messages in such
cases usually makes the actual problem less clear.</p>
</section>
</section>
</section>
<section id="diffpos">
<h3>diffpos<a class="headerlink" href="#diffpos" title="Link to this heading">¶</a></h3>
<section id="id5">
<h4>SYNOPSIS<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h4>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">diffpos</span></code> <cite>FILE1</cite> <cite>FILE2</cite> [<cite>THRESHOLD</cite>]</p>
</div></blockquote>
</section>
<section id="id6">
<h4>DESCRIPTION<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h4>
<p>Diffpos reports stations which are in one file but not the other, and
also stations which have moved by more than a specified threshold
distance in X, Y, or Z. <cite>THRESHOLD</cite> is a distance in metres and
defaults to 0.01m if not specified.</p>
<p>Note that the input files can be any format the “img” library can read (and
can be different formats), so it works with Survex <code class="docutils literal notranslate"><span class="pre">.3d</span></code> and <code class="docutils literal notranslate"><span class="pre">.pos</span></code> files,
Compass <code class="docutils literal notranslate"><span class="pre">.plt</span></code> and <code class="docutils literal notranslate"><span class="pre">.plf</span></code> files, CMAP <code class="docutils literal notranslate"><span class="pre">.sht</span></code>, <code class="docutils literal notranslate"><span class="pre">.adj</span></code> and <code class="docutils literal notranslate"><span class="pre">.una</span></code>
files.</p>
</section>
<section id="id7">
<h4>OPTIONS<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display short help and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
</section>
</section>
<section id="dump3d">
<h3>dump3d<a class="headerlink" href="#dump3d" title="Link to this heading">¶</a></h3>
<section id="id9">
<h4>SYNOPSIS<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h4>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">dump3d</span></code> [–survey=<cite>SURVEY</cite>] [–rewind] [–show-dates] [–legs] <cite>INPUT_FILE</cite></p>
</div></blockquote>
</section>
<section id="id10">
<h4>DESCRIPTION<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h4>
<p>Dump out the entries in a processed survey data file - useful for debugging,
and also provides a textual format which is fairly easy to parse if you want
to write a simple script to pull out information from such files.</p>
<p>Don’t be mislead by the “3d” in this tool’s name - it can be used to dump a
file in any format the “img” library can read, so it works with Survex <code class="docutils literal notranslate"><span class="pre">.3d</span></code>
and <code class="docutils literal notranslate"><span class="pre">.pos</span></code> files, Compass <code class="docutils literal notranslate"><span class="pre">.plt</span></code> and <code class="docutils literal notranslate"><span class="pre">.plf</span></code> files, CMAP <code class="docutils literal notranslate"><span class="pre">.sht</span></code>,
<code class="docutils literal notranslate"><span class="pre">.adj</span></code> and <code class="docutils literal notranslate"><span class="pre">.una</span></code> files.</p>
<p>If you’re parsing the output in a script, you may want to use option <code class="docutils literal notranslate"><span class="pre">-legs</span></code>
so you get a <code class="docutils literal notranslate"><span class="pre">LEG</span></code> item for each leg with from and to coordinates instead of
each traverse being a <code class="docutils literal notranslate"><span class="pre">MOVE</span></code> item followed by a series of <code class="docutils literal notranslate"><span class="pre">LINE</span></code> items.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">--show-dates</span></code> option uses <code class="docutils literal notranslate"><span class="pre">.</span></code> as the separator between date components
by default (e.g. <code class="docutils literal notranslate"><span class="pre">2024.12.01</span></code>), but (since Survex 1.4.13) you can specify a
different separator. If this separator is <code class="docutils literal notranslate"><span class="pre">.</span></code> then <code class="docutils literal notranslate"><span class="pre">-</span></code> is used between two
dates which form a range, otherwise a space is used. For convenience, <code class="docutils literal notranslate"><span class="pre">-D</span></code>
is provided as a short-cut for <code class="docutils literal notranslate"><span class="pre">--show-dates=-</span></code> which outputs dates in the
ISO date format.</p>
<p>(The <code class="docutils literal notranslate"><span class="pre">--rewind</span></code> option is only provided to allow debugging and testing the
<code class="docutils literal notranslate"><span class="pre">img_rewind()</span></code> function.)</p>
</section>
<section id="id11">
<h4>OPTIONS<a class="headerlink" href="#id11" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-s</span></code>, <code class="docutils literal notranslate"><span class="pre">--survey=</span></code><cite>SURVEY</cite></dt><dd><p>only load the sub-survey with this prefix</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-r</span></code>, <code class="docutils literal notranslate"><span class="pre">--rewind</span></code></dt><dd><p>rewind file and read it a second time</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-d</span></code>, <code class="docutils literal notranslate"><span class="pre">--show-dates[=SEPARATOR]</span></code></dt><dd><p>show survey date information (if present)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-D</span></code></dt><dd><p>equivalent to –show-dates=-</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-l</span></code>, <code class="docutils literal notranslate"><span class="pre">--legs</span></code></dt><dd><p>convert MOVE and LINE into LEG</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display short help and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
</section>
</section>
<section id="extend">
<h3>extend<a class="headerlink" href="#extend" title="Link to this heading">¶</a></h3>
<section id="id13">
<h4>SYNOPSIS<a class="headerlink" href="#id13" title="Link to this heading">¶</a></h4>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">extend</span></code> [–survey=<cite>SURVEY</cite>] [–specfile=<cite>ESPEC_FILE</cite>] [–show-breaks] <cite>INPUT_FILE</cite> [<cite>OUTPUT_3D_FILE</cite>]</p>
</div></blockquote>
</section>
<section id="id14">
<h4>DESCRIPTION<a class="headerlink" href="#id14" title="Link to this heading">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">INPUT_FILE</span></code> can be a Survex <code class="docutils literal notranslate"><span class="pre">.3d</span></code> file, a Compass <code class="docutils literal notranslate"><span class="pre">.plt</span></code> file or a
CMAP <code class="docutils literal notranslate"><span class="pre">.sht</span></code> file (all Survex programs which read <code class="docutils literal notranslate"><span class="pre">.3d</span></code> files can also
transparently handle these formats).</p>
<p>If no <code class="docutils literal notranslate"><span class="pre">--specfile</span></code> option (or short option <code class="docutils literal notranslate"><span class="pre">-p</span></code>) is given, extend starts
with the highest station marked as an entrance which has at least one
underground survey leg attached to it. If there are no such stations, the
highest deadend station in the survey (or the highest station if there are no
deadends) is used. Extend puts the first station on the left, then folds each
leg out individually to the right, breaking loops arbitrarily (usually at
junctions).</p>
<p>If the output filename is not specified, extend bases the output filename on
the input filename, but replacing the extension with <code class="docutils literal notranslate"><span class="pre">_extend.3d</span></code>. For
example, <code class="docutils literal notranslate"><span class="pre">extend</span> <span class="pre">deep_pit.3d</span></code> produces an extended elevation called
<code class="docutils literal notranslate"><span class="pre">deep_pit_extend.3d</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">--survey=</span></code><cite>SURVEY</cite> option (short option <code class="docutils literal notranslate"><span class="pre">-s</span></code>) restricts processing to
the survey <cite>SURVEY</cite> including any sub-surveys.</p>
<p>If you pass <code class="docutils literal notranslate"><span class="pre">--show-breaks</span></code> (short option <code class="docutils literal notranslate"><span class="pre">-b</span></code>) then a leg flagged as
“surface survey” will be added between each point at which a loop has been
broken - this can be very useful for visualising the result in aven.</p>
<p>This approach suffices for simple caves or sections of cave, but for
more complicated situations human intervention is required. More
complex sections of cave can be handled with a specfile giving
directions to switch the direction of extension between left and
right, to explicitly specify the start station, or to break the
extension at particular stations or legs.</p>
<p>The specfile is in a format similar to cavern’s data format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>; This is a comment
; start the elevation at station entrance.a
*start entrance.a ;this is a comment after a command
; start extending leftwards from station half-way-down.5
*eleft half-way-down.5
; change direction of extension at further-down.8
*eswap further-down.8
; extend right from further-down.junction, but only for
; the leg joining it to very-deep.1, other legs continuing
; as before
*eright further-down.junction very-deep.1
; break the survey at station side-loop.4
*break side-loop.4
; break survey at station side-loop.junction but only
; for leg going to complex-loop.2
*break side-loop.junction complex-loop.2
</pre></div>
</div>
<p>This approach requires some trial and error, but gives useful results
for many caves. The most complex systems would benefit from an
interactive interface to select and view the breaks and switches of
direction.</p>
</section>
</section>
<section id="sorterr">
<h3>sorterr<a class="headerlink" href="#sorterr" title="Link to this heading">¶</a></h3>
<section id="id16">
<h4>SYNOPSIS<a class="headerlink" href="#id16" title="Link to this heading">¶</a></h4>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">sorterr</span></code> [<cite>OPTIONS</cite>] <cite>ERR_FILE</cite> [<cite>HOW_MANY</cite>]</p>
</div></blockquote>
</section>
<section id="id17">
<h4>DESCRIPTION<a class="headerlink" href="#id17" title="Link to this heading">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">sorterr</span></code> re-sorts a .err file by the specified criterion (or by the error ratio
by default). Output is sent to stdout, or if <code class="docutils literal notranslate"><span class="pre">--replace</span></code> (short option
<code class="docutils literal notranslate"><span class="pre">-r</span></code>) is specified the input file is replaced with the sorted version. By
default all entries in the file are included - if a second parameter is given
then only the top <code class="docutils literal notranslate"><span class="pre">HOW_MANY</span></code> entries after sorting are returned.</p>
</section>
<section id="id18">
<h4>OPTIONS<a class="headerlink" href="#id18" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-h</span></code>, <code class="docutils literal notranslate"><span class="pre">--horizontal</span></code></dt><dd><p>sort by horizontal error factor</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-v</span></code>, <code class="docutils literal notranslate"><span class="pre">--vertical</span></code></dt><dd><p>sort by vertical error factor</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-p</span></code>, <code class="docutils literal notranslate"><span class="pre">--percentage</span></code></dt><dd><p>sort by percentage error</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-l</span></code>, <code class="docutils literal notranslate"><span class="pre">--per-leg</span></code></dt><dd><p>sort by error per leg</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-r</span></code>, <code class="docutils literal notranslate"><span class="pre">--replace</span></code></dt><dd><p>replace .err file with re-sorted version</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display short help and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
</section>
</section>
<section id="survexport">
<h3>survexport<a class="headerlink" href="#survexport" title="Link to this heading">¶</a></h3>
<section id="id20">
<h4>SYNOPSIS<a class="headerlink" href="#id20" title="Link to this heading">¶</a></h4>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">survexport</span></code> [<cite>OPTIONS</cite>] <cite>INPUT_FILE</cite> [<cite>OUTPUT_FILE</cite>]</p>
</div></blockquote>
</section>
<section id="id21">
<h4>DESCRIPTION<a class="headerlink" href="#id21" title="Link to this heading">¶</a></h4>
<p>The input formats supports are all those supported by Survex’s “img”
library - Survex .3d, Survex .pos, Compass PLT and CMAP XYZ files.</p>
<p>Currently the output formats supported are CSV, DXF, EPS
(Encapsulated PostScript), GPX, HPGL for plotters, JSON, KML, Survex
POS files, and SVG.</p>
<p>Also survexport can produce Compass .plt files, which were primarily intended
for importing into Carto; the principal author of Carto has sadly died and it
seems Carto is no longer actively developed, but we’ve left this support in
place in case it is useful - the generated files can be used with Compass
itself for example, though they are rather crudely structured.</p>
<section id="pos-format">
<h5>POS Format<a class="headerlink" href="#pos-format" title="Link to this heading">¶</a></h5>
<p>The POS format is a Survex-specific format containing a list of stations with
coordinates (ordered x,y,z [East, North, Up]) and complete names. In old
versions of Survex it was produced by the (now removed) <code class="docutils literal notranslate"><span class="pre">3dtopos</span></code> tool.
Since Survex 1.2.19 it can be generated by <code class="docutils literal notranslate"><span class="pre">survexport</span></code> or by <code class="docutils literal notranslate"><span class="pre">aven</span></code>’s
export feature.</p>
<p>The header line is translated to the user’s language, but always starts with
<code class="docutils literal notranslate"><span class="pre">(</span></code> and ends with <code class="docutils literal notranslate"><span class="pre">)</span></code>.</p>
<p>While not a requirement of the format, in <code class="docutils literal notranslate"><span class="pre">.pos</span></code> files created by Survex
the stations are sorted by name such that numbers occur in the correct order
(so <code class="docutils literal notranslate"><span class="pre">2</span></code> before <code class="docutils literal notranslate"><span class="pre">10</span></code>). Numbers with a prefix and/or suffix are sorted by
the prefix as a string, then the number part as above, then by the suffix as
a string, so you’d get:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>040.sv8
040.sv8a
040.sv8b
040.sv8c
040.sv9
040.sv10
040.sv11
40_entrance_tag
40b_entrance_tag
</pre></div>
</div>
</section>
<section id="dxf-format">
<h5>DXF Format<a class="headerlink" href="#dxf-format" title="Link to this heading">¶</a></h5>
<p>DXF export separates Splays, Surface legs, Surface points, survey
legs, and survey stations onto separate layers. Splays will export
dotted, and surface legs dashed. This is not currently configurable.</p>
</section>
</section>
<section id="id22">
<h4>OPTIONS<a class="headerlink" href="#id22" title="Link to this heading">¶</a></h4>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">-s</span></code>, <code class="docutils literal notranslate"><span class="pre">--survey=</span></code><cite>SURVEY</cite></dt><dd><p>only load the sub-survey with this prefix</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--scale=</span></code><cite>SCALE</cite></dt><dd><p>scale (<code class="docutils literal notranslate"><span class="pre">50</span></code>, <code class="docutils literal notranslate"><span class="pre">0.02</span></code>, <code class="docutils literal notranslate"><span class="pre">1:50</span></code> and <code class="docutils literal notranslate"><span class="pre">2:100</span></code> all mean 1:50)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--bearing=</span></code><cite>BEARING</cite></dt><dd><p>bearing (<code class="docutils literal notranslate"><span class="pre">90</span></code>, <code class="docutils literal notranslate"><span class="pre">90d</span></code>, <code class="docutils literal notranslate"><span class="pre">100g</span></code> all mean 90°)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--tilt=</span></code><cite>TILT</cite></dt><dd><p>tilt (<code class="docutils literal notranslate"><span class="pre">45</span></code>, <code class="docutils literal notranslate"><span class="pre">45d</span></code>, <code class="docutils literal notranslate"><span class="pre">50g</span></code>, <code class="docutils literal notranslate"><span class="pre">100%</span></code> all mean 45°)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--plan</span></code></dt><dd><p>plan view (equivalent to <code class="docutils literal notranslate"><span class="pre">--tilt=-90</span></code>)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--elevation</span></code></dt><dd><p>elevation view (equivalent to <code class="docutils literal notranslate"><span class="pre">--tilt=0</span></code>)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--legs</span></code></dt><dd><p>underground survey legs</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--surface-legs</span></code></dt><dd><p>surface survey legs</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--splays</span></code></dt><dd><p>splay legs</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--crosses</span></code></dt><dd><p>station markers</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--station-names</span></code></dt><dd><p>station labels</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--entrances</span></code></dt><dd><p>entrances</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--fixes</span></code></dt><dd><p>fixed points</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--exports</span></code></dt><dd><p>exported stations</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--cross-sections</span></code></dt><dd><p>cross-sections</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--walls</span></code></dt><dd><p>walls</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--passages</span></code></dt><dd><p>passages</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--origin-in-centre</span></code></dt><dd><p>origin in centre</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--full-coordinates</span></code></dt><dd><p>full coordinates</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--clamp-to-ground</span></code></dt><dd><p>clamp to ground</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--defaults</span></code></dt><dd><p>include items exported by default</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-g</span></code>, <code class="docutils literal notranslate"><span class="pre">--grid</span></code>, <code class="docutils literal notranslate"><span class="pre">--grid=</span></code><cite>GRID</cite></dt><dd><p>generate grid with spacing <code class="docutils literal notranslate"><span class="pre">GRID</span></code> metres (default <code class="docutils literal notranslate"><span class="pre">100</span></code>)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-t</span></code>, <code class="docutils literal notranslate"><span class="pre">--text-height=</span></code><cite>TEXT_HEIGHT</cite></dt><dd><p>station labels text height (default <code class="docutils literal notranslate"><span class="pre">0.6</span></code>)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-m</span></code>, <code class="docutils literal notranslate"><span class="pre">--marker-size=</span></code><cite>MARKER_SIZE</cite></dt><dd><p>station marker size (default <code class="docutils literal notranslate"><span class="pre">0.8</span></code>)</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--csv</span></code></dt><dd><p>produce CSV output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--dxf</span></code></dt><dd><p>produce DXF output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--eps</span></code></dt><dd><p>produce EPS output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--gpx</span></code></dt><dd><p>produce GPX output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--hpgl</span></code></dt><dd><p>produce HPGL output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--json</span></code></dt><dd><p>produce JSON output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--kml</span></code></dt><dd><p>produce KML output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--plt</span></code></dt><dd><p>produce Compass PLT output for Carto</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--pos</span></code></dt><dd><p>produce Survex POS output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--svg</span></code></dt><dd><p>produce SVG output</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>display short help and exit</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>output version information and exit</p>
</dd>
</dl>
</section>
</section>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.htm">Survex</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.htm">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="getstart.htm">Getting Started</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Survex Programs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#standard-options">Standard Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="#short-and-long-options">Short and Long Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="#filenames-on-the-command-line">Filenames on the Command Line</a></li>
<li class="toctree-l2"><a class="reference internal" href="#command-reference">Command Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#aven">aven</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cavern">cavern</a></li>
<li class="toctree-l3"><a class="reference internal" href="#diffpos">diffpos</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dump3d">dump3d</a></li>
<li class="toctree-l3"><a class="reference internal" href="#extend">extend</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sorterr">sorterr</a></li>
<li class="toctree-l3"><a class="reference internal" href="#survexport">survexport</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="datafile.htm">Survex data files</a></li>
<li class="toctree-l1"><a class="reference internal" href="svxhowto.htm"><code class="docutils literal notranslate"><span class="pre">.svx</span></code> Cookbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="genhowto.htm">General: How do I?</a></li>
<li class="toctree-l1"><a class="reference internal" href="compass.htm">Larry Fish’s Compass</a></li>
<li class="toctree-l1"><a class="reference internal" href="walls.htm">David McKenzie’s Walls</a></li>
<li class="toctree-l1"><a class="reference internal" href="cmap.htm">Bob Thrun’s CMAP</a></li>
<li class="toctree-l1"><a class="reference internal" href="img.htm">Using the img library</a></li>
<li class="toctree-l1"><a class="reference internal" href="maillist.htm">Mailing List</a></li>
<li class="toctree-l1"><a class="reference internal" href="future.htm">Future Developments</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.htm">Documentation overview</a><ul>
<li>Previous: <a href="getstart.htm" title="previous chapter">Getting Started</a></li>
<li>Next: <a href="datafile.htm" title="next chapter">Survex data files</a></li>
</ul></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.htm" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©1998-2025.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
& <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
</div>
</body>
</html>
|
