-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathedghelp.txt
7037 lines (4842 loc) · 191 KB
/
edghelp.txt
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
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
!
! EdG Help file
!
! $RCSfile: edghelp.txt,v $
! $Revision: 6.10 $
! $Date: 1999/02/26 16:14:54 $
!
! The variable EDG_HELPLIB should be defined to point to the
! edghelp.hlp file. Please note that this is a full file specification
! and not a partial path to the file.
!
! examples:
!
! PC set EDG_HELPLIB=\ustation\edg\edghelp.hlp
! UNIX export EDG_HELPLIB=/usr/ip32/ustation/edg/edghelp.hlp
! Mac not-needed
!
! The MAC and PC do not require the EDG_HELPLIB environment variable
! as long as the edghelp.hlp file is in the same directory with the
! EdG application.
!
!
! Check the "release-notes" topic in HELP for information on changes to
! this version.
!
! Check the "release-notes differences" if you are an user of either
! an earlier version of MicroStation/EDG or VAX/EDG.
!
!===
!
! Even though this file is primarily designed as a help file it can be
! used as a working document for EdG.
!
!=======================================================================
! Help Instructions
!=======================================================================
#1 getting_started
EdG is a product, that offers many features to aid the user. These
features include:
* An element sequence numbering system that allows the user to refer to
elements in a manner similar to text editors.
* A wide range of element display formats.
* The ability to set up default element search criteria.
* Commands to modify, delete, or even undelete elements.
* Command files, which let you specify editing sequences or
characteristics.
* The ability to accumulate statistics about elements.
* Generation of new files from the existing file.
* A journaling capability to save the output of the session.
* The capability of fixing files without needing to know the details of
MicroStation or IGDS elements or file formats.
#2 sequence-numbers
EdG assigns element "sequence" numbers to each element in the design file.
All elements are assigned sequential numbers, regardless of status, search
criteria, etc.. These numbers may range anywhere from 1 to about 16-
million. EdG numbers the elements, starting with 1, in increments of 1.
The sequence numbers are displayed on the far left side of the listing.
Most EdG commands use sequence numbers or sequence ranges for the mechanism
for identifying the elements to be processed.
#3 single-element-ranges
A single element range defines the element in the design file on which you
want a command to operate.
#3 multiple-element-ranges
Multiple element ranges define sets of consecutive elements within the
design file.
#2 display-formats
EdG displays information about files with the SHOW command and about
elements with the SET DISPLAY command.
#3 show
The sub-commands available for the show command are:
display search
files size
help verify
mode versions
#3 set_display
The qualifiers available for the set display command are:
/attribute /pdata
/brief /position
/data /properties
/dump /radix
/full /range
/graphic /scale_size
/header /symbology
/number_of /text
/orientation /working_units
/parameters
See SET DISPLAY for information about each qualifier.
#2 search-criteria
The default search criteria may be changed with the set search command.
Valid qualifiers are:
/all_elements /level
/cellname /linkage
/characters /nest
/class /p_bits
/color /status
/element /style
/expand /type
/font /weight
/group
See SET SEARCH for information about each qualifier.
#2 modification-commands
Elements may be modified in two ways using the modify command.
#3 keyword
When modifying elements by keyword any of the following qualifiers may be
specified:
characters style
class weight
color
element xhigh
font xlow
group yhigh
level ylow
p_bits zhigh
status zlow
See MODIFY for information about each qualifier.
#3 offset
When modifying elements by offset the word to be modified within the
element's description is specified in the MODIFY ELEMENT( ) command. For
example,
MODIFY ELEMENT(15)=0
would modify word 15 (graphic group number) of the current element.
#2 command_files
EdG has the capability of executing commands from external command files.
When EdG is first invoked, the user's directory is searched for a file
named EDGINI.EDG which is treated as a startup command file. Commands may
also be executed from command files by typing the name of the command file
preceded by the @ symbol.
#2 file-statistics
Statistics about design file or cell libraries may be generated and
displayed using the following command:
SET SEARCH/whatever
SUMMARY WHOLE
SHOW SIZE
For more information, see SUMMARY
#1 Hints
Type the name of one of the categories listed below to obtain a list of
related commands and topics. To obtain detailed information on a topic,
press the RETURN key until you reach the "Topic?" prompt and then type the
name of the topic.
Topics that appear in all upper case are EdG commands or EdG keywords.
#2 Display-commands
TYPE
BRIEF
FULL
TOP
return (null)
#2 Modification-commands
DELETE
UNDELETE
MODIFY
#2 Files-usage
BACKUP
EDG
OPEN
WRITE
CLOSE
EXIT
#2 Setting-defaults
SET
SHOW
#2 Analysis-and-repair
DEMARCATE
UNDEMARCATE
EVALUATE
PATCH
REPAIR
SUMMARY
VERIFY
#1 instructions
Invoking the HELP command
-------------------------
The HELP command displays information about requested EdG topics. From the
"EdG>" prompt you can display a list of topics for which help information
is available by typing HELP and pressing the RETURN key. EdG responds by
displaying a brief description of how to use HELP, followed by a list of
topics for which help is available, followed by the prompt "Topic?".
You can exit from the HELP command by typing a break sequence in response
to any prompt. The break sequence is slightly different on different
systems: DOS - N/A (must press return one or more times), Mac - COMMAND-
PERIOD, Unix - CTRL/C.
Specifying topic names
----------------------
To display information on a particular topic, respond to the prompt by
typing the name of the topic and pressing the RETURN key. You may
abbreviate any topic name, although ambiguous abbreviations result in all
matches being displayed.
If you are not sure of the name of the topic for which you need help, type
the name HINTS.
To display information on all available topics, type an asterisk (*).
You can specify percent signs (%) and asterisks (*) in the keyword as wild
card (i.e., match all) characters. Abbreviations result in all matches
being displayed.
Subtopic information
--------------------
The information displayed by HELP on a particular topic includes a
description of the topic and a list of subtopics that further describe the
topic. To display subtopic information, type one of the subtopic names
from the list in response to the "Subtopic?" prompt. The general rules for
specifying subtopics is the same as for entering topics (see above).
Special responses to prompts
----------------------------
If you press RETURN in response to the "Subtopic?" prompt instead of typing
a subtopic name, the previous subtopics or the "Topic?" prompt reappears,
enabling you to enter another topic name. If you press RETURN in response
to the "Topic?" prompt, you will exit from HELP.
You can enter a question mark (?) in response to any of the prompts to
redisplay the most recently requested text and a list of topic or subtopic
names. For example, if you type ? in response to the "Subtopic?" prompt,
a list of subtopics is displayed followed by the "Subtopic?" prompt.
Help topic case conventions
---------------------------
The EdG help library maintains a convention concerning the help topics and
their naming case. All commands and keywords are listed in all upper-case
and informational topics are listed in all lower-case or the first letter
capitalized followed by lower-case.
!
!=======================================================================
! EdG sequence range
!=======================================================================
#1 sequence-ranges
Sequence range specifications are used on most commands to select the exact
elements on which the command will operate.
There are two general classes of sequence ranges;
* Single element ranges specify a single element.
* Multiple element ranges specify blocks of elements, such as all
elements from the current element to the end-of-design.
Please remember that the current search criteria affects which elements
will be returned.
A sequence range specified without a command is an implied TYPE command.
#2 AFTER
The AFTER range is a multiple element range which specifies the elements
following, but not including the current element.
This is equivalent to entering;
CURRENT+1 THRU END
#2 BEFORE
The BEFORE range is a multiple element range which specifies the elements
in the file preceding, but not including, the current element.
This is equivalent to entering;
BEGIN THRU CURRENT-1
#2 BEGIN
The BEGIN range is a single element range which specifies the first element
in the file. This is equivalent to entering the number one (1).
TOP is an alias for BEGIN.
#2 CURRENT
The CURRENT range is a single element range which is the current element.
#2 dot
The dot (.) is a single element range which refers to the current element.
For many commands, dot is the default range. See the text for a command if
you are unsure of the default.
#3 examples
TYPE .
types the current element.
#2 END_OF_DESIGN
The END_OF_DESIGN range specifies the IGDS/MicroStation end-of-data marker
in the design. This range does NOT specify the last element in the file.
format:
END_OF_DESIGN
#2 FIRST
The FIRST_OCCURRENCE range specifies the first element in the file that
meets the current search criteria.
format:
FIRST [number]
The optional number indicates the occurrence of the element. The default
is one (1).
#2 FOR
The FOR range is a multiple element range which selects a specified number
of elements starting at a specified location.
format:
[range] FOR n
[range] # n
The two forms are equivalent. Range is a single element range which
specifies the starting position, and n is an integer number. If range is
omitted, the current element is the starting position.
#3 examples
TYPE . FOR 5
type 5 elements, starting with the current element.
TYPE # 5
equivalent to the previous example
#2 HEADER
The HEADER range is a single element range which identifies the complex
element header if the current element is a component of a complex group.
#2 minus
The Minus sign in ranges specifies a single element which is a specified
number of elements before the indicated element.
format:
range - n
- [n]
Range is a single element range and n is an integer.
If the "range - n" format is used the element selected is the element which
is n elements before the element specified by range.
If the "- n" format is used, it is equivalent to the "PREVIOUS n" format.
If n is omitted 1 is used.
#2 NEXT
The NEXT_OCCURRENCE range is a single element range which indicates the
next element in the file that meets the current search criteria.
format:
NEXT [number]
+ [number]
The optional number indicates the occurrence of the element. The default
is one.
#2 number
A sequence number is a single element range which refers to the element
having the specified sequence number.
#3 examples
TYPE 37
type element 37
DELETE 52
delete element 52
If the element does not match the search criteria, no action takes place.
#2 OCCURRENCE
The OCCURRENCE range is equivalent to the FIRST_OCCURRENCE range.
format:
OCCURRENCE [number]
The optional number indicates the occurrence of the element. The default
is one (1).
(see also FIRST_OCCURRENCE)
#2 plus
The plus sign is used in ranges to select a single element which is a
specified number of elements after the indicated element.
format:
range + [n]
+ [n]
Range is a single element range and n is a number.
For the "range + n" format the element selected is the element that is 'n'
number of elements after range.
For the "+ n" format this is equivalent to using the "NEXT n" sequence
range.
If the number is omitted, one (1) is used.
#2 PREVIOUS
The PREVIOUS_OCCURRENCE range specifies the element prior to the current
that matches the current search criteria.
format:
PREVIOUS [n]
- [n]
The optional number indicates the occurrence of the element. The default
is one (1).
#2 REST
The REST range is a multiple element range which refers to the current
element and all elements following in the design file.
This is equivalent to entering;
CURRENT THRU END_OF_DESIGN
#2 THRU
The THRU range is a multi-element range which specifies all elements
between two single element ranges.
format:
range_1 THRU range_2
range_1 : range_2
Both forms are equivalent. Starting with range_1, EdG selects the
elements up to and including the element specified by range_2.
#3 examples
TYPE 5:30
type all elements starting with sequence number 5 through element 30.
TYPE 50:END
type all elements starting with sequence number 50 through the end-of-file.
#2 WHOLE
The WHOLE range refers to the entire design file.
This is equivalent to entering;
BEGIN THRU END_OF_DESIGN
ALL is a synonym for the WHOLE sequence range.
!
!=======================================================================
! EdG commands
!=======================================================================
#1 HELP
EdG -- Edit Graphics
The EdG utility is provided to allow the user to display, search, modify
and analyze MicroStation and IGDS design and cell files in a non-graphic
environment.
To display information about an EdG command or topic. In response to the
"Topic?" prompt, you can:
* Enter the name of the command or topic for which you need help.
* Enter HINTS if you are not sure of the name of the command or topic for
which you need help.
* Enter INSTRUCTIONS for more detailed instructions on how to use HELP.
#2 EDG_HELPLIB
The default EdG help file is defined by the environment variable / logical
name EDG_HELPLIB. Please note that this is a full file specification and
not a partial path to the file.
examples:
set EDG_HELPLIB=\ustation\edg\edghelp.hlp
export EDG_HELPLIB=/usr/ip32/ustation/edg/edghelp.hlp
When looking for the HELP file, EdG looks in several locations:
* EdG will first look for the environment variable EDG_HELPLIB. If it
exists it should point either directly to the help file or specify a
directory (if it is a directory it should end with the directory separator
character, and the file "edghelp.hlp" will be appended).
* Next EdG will look for the environment variable MS_EDG. If it exists it
should specify a directory (with directory separator) or point to the EdG
application. The file "edghelp.hlp" will be appended.
* Last (for the PC and the MAC only) the directory where EdG is being run
from (the application's "home" directory) is known by EdG itself, and it
looks for the file "edghelp.hlp" at that location.
!
!=======================================================================
! DISPLAY commands
!=======================================================================
#1 TYPE
Outputs a formatted description of the elements specified by the optional
range.
format:
TYPE [seq_range]
Display and search qualifiers may be used on the command line to
temporarily override the default. (see the SET SEARCH and SET DISPLAY
commands)
#1 BRIEF
Displays the current element in brief
format:
BRIEF
This command is actually equivalent to:
TYPE CURRENT /BRIEF /ALL_ELEMENTS
#1 FULL
Displays the current element in full
format:
FULL
This command is actually an alias for:
TYPE CURRENT /FULL /ALL_ELEMENTS
#1 TOP
Moves to the beginning of the file, regardless of the search criteria, and
displays the first element.
format:
TOP
This command is actually equivalent to:
TYPE BEGIN /ALL_ELEMENTS
#1 implied-commands
Some qualifiers or keywords when specified without an explicit command will
imply a command or operation.
* the null command (pressing return without typing anything) implies the
TYPE NEXT command.
* any sequence-range implies the TYPE command.
* a display qualifier without a sequence-range implies the TYPE CURRENT
command.
* a search qualifier without a sequence-range implies the TYPE NEXT
command.
#1 interrupt-command
EdG provides a mechanism to abort or interrupt an operation through the use
of a break sequence. On most machines the break sequence is CONTROL/C (on
the Macintosh it is command-period). The operation may not immediately
stop but will stop at the next logical break point.
!
!=======================================================================
! FILE commands
!=======================================================================
#1 command-files
Command files are sequences of EdG commands that can then be executed
later.
EdG provides two types of command files:
1) startup command files and
2) indirect (batch) files.
#2 Batch-files
Causes EdG to read the specified file as the command input. The file name
for an EdG command file may be any legal file-specification for the current
operating system. The default file suffix is ".edg".
format:
@filename
The EdG command file may contain a list of any legal EdG commands. The
user may wish to comment some sections of the command file. An exclamation
point is used to begin comments. An empty line with nothing but a comment
is also legal.
----------
>> NOTE <<
----------
The user may also specify batch (command) files from the EdG invocation
command line. For example: "edg file.dgn @batch.edg".
#2 Startup-file
EdG provides for a startup command file. When EdG is first initiated it
searches for a file named "edgini.edg". If present, it is opened and all
valid EdG commands (except EXIT) are executed.
Example:
SET VERIFY/ALL/TYPE=STANDARD
SET SEARCH/ALL
#2 Open-command-file
EdG provides for an open design command file. When EdG opens a design or
cell file it searches for a file named "edgdgn.edg". If present, it is
opened and all valid EdG commands (except EXIT) are executed.
Example:
SET VERIFY/ALL/TYPE=STANDARD
SET SEARCH/ALL
SET PROMPT FILE
#1 BACKUP
Creates a backup of the current design/cell file.
format:
BACKUP [filename]
If the file name is omitted, the backup file is created with the name of
the current design file or cell library with a suffix of ".bak". If a
backup command was previously issued and no file name is specified then the
current backup is updated.
#1 EDG
Closes the current file and opens the specified design/cell file.
format:
EDG filename
#1 EXIT
Close all files and exit the EdG utility.
format:
EXIT
XIT
#1 CLOSE
Closes the secondary file previously opened by the OPEN command.
format:
CLOSE
(see OPEN)
#1 OPEN
Creates a new file based on the currently open file. The header
information (type 9,8,10 for design or type 5 for cell files) is copied
into the new file.
format:
OPEN filename
(See also commands; WRITE and CLOSE)
----------
>> NOTE <<
----------
Only type 8,9 and 10 elements are written into the new file by default.
If any other elements are required, (such as a second type 9 or an
application type element) it will be necessary to include them in the list
of elements being written to the new file.
#1 WRITE
Writes elements into the secondary file indicated by the OPEN command.
format:
WRITE [seq_range]
The elements written are those returned by the search criteria.
(see OPEN)
!
!=======================================================================
! MODIFICATION commands
!=======================================================================
#1 DELETE
Used to mark the element for delete.
format:
DELETE [seq_range]
If the optional sequence range is omitted the current element is marked for
delete. If the sequence range is provided, the elements within that range
(according to the search criteria) are marked for delete
----------
>> NOTE <<
----------
If the current element is part of a complex element group or the element
is marked as LOCKED by the properties (see MODIFY PBITS) an error is
generated.
If a complex element header is deleted all elements within the complex
group are deleted.
*************
** WARNING **
*************
Deleting complex headers causes all element sequence numbers that follow
to be resequenced.
#1 MODIFY
Modifies the element's value of the specified keyword.
format:
MODIFY keyword = value [seq_range]
The value by default is decimal. If octal or hex is desired simply prefix
the value with '%O' for octal or '%X' for hex. The 'C' syntax of prefixing
the value with a zero indicating octal (e.g., 07777) or zero followed by 'x'
(e.g., 0xFFFF) is also allowed.
If the optional sequence range is omitted the current element is modified.
Only those elements returned by the current search criteria are modified.
#2 arithmetic_operations-not
(NOT CURRENTLY IMPLEMENTED)
MODIFY allows simple arithmetic operations on certain keywords. These
operations arithmetically change the contents instead of replacing. To use
this feature the command line syntax is;
MODIFY keyword op= value
where op may be one of; +, -, *, / for add, subtract, multiply and divide
respectively. This has the affect of taking the original element value
performing the operation with the supplied value and inserting it into the
element (e.g. keyword = keyword op value).
The legal keywords are:
CLASS
COLOR
FONT
GROUP
LEVEL
STYLE
WEIGHT
#2 ALINKAGE
Modifies any particular word within the attribute data.
format:
MODIFY ALINKAGE(subscript)=value
The value by default is decimal but may be overridden by using the
following.
%D = decimal
%O = octal
%X = hex
%F = floating point (real*8)
%R = radix-50
[these additional keywords are used with %D, %O, and %X only]
(HIGH) = modify high order byte
(LOW) = modify low order byte
(SWAP) = modify swapped (coordinate style) long word
(LONG) = modify (vax style) long word
#2 CHARACTERS
Modifies the character text of a text element.
format:
MODIFY CHARACTERS=item
The 'item' may be one of the following:
#3 LOWER-not
(NOT YET IMPLEMENTED)
MODIFY CHARACTERS = LOWER
This keyword causes the element's text to be converted to all lowercase
characters. (text enclosed within quotes (") are not affected)
#3 UPPER-not
(NOT YET IMPLEMENTED)
MODIFY CHARACTERS = UPPER
This keyword causes the element's text to be converted to all uppercase
characters. (text enclosed within quotes (") are not affected)