]> git.pld-linux.org Git - packages/JADE.git/blob - jade-manpages.patch
- Name changed to JADE
[packages/JADE.git] / jade-manpages.patch
1 diff -Nru jade-1.2.1/jade.1 jade-1.2.1.new/jade.1
2 --- jade-1.2.1/jade.1   Thu Jan  1 01:00:00 1970
3 +++ jade-1.2.1.new/jade.1       Tue Sep 21 22:48:19 1999
4 @@ -0,0 +1,28 @@
5 +.TH JADE 1
6 +.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
7 +.\" other parms are allowed: see man(7), man(1)
8 +.SH NAME
9 +jade \- James' DSSSL Engine
10 +.SH SYNOPSIS
11 +.B jade
12 +.I "[options] files ..."
13 +.SH "DESCRIPTION"
14 +This manual page documents briefly the
15 +.BR jade
16 +command.
17 +This manual page was written for the Debian GNU/Linux distribution
18 +(but may be used by others), because the original program does not
19 +have a manual page.
20 +Instead, it has documentation in HTML format; see below.
21 +.PP
22 +.B jade
23 +is an implementation of the DSSSL style language.
24 +The current version is 1.1.
25 +.SH OPTIONS
26 +For a complete description, see the html files.
27 +.SH "SEE ALSO"
28 +The programs are documented fully in
29 +.B /usr/doc/jade/jade.htm
30 +.SH AUTHOR
31 +This manual page was written by Mark W. Eichin <eichin@kitten.gen.ma.us>,
32 +for the Debian GNU/Linux system.
33 diff -Nru jade-1.2.1/nsgmls/nsgmls.1 jade-1.2.1.new/nsgmls/nsgmls.1
34 --- jade-1.2.1/nsgmls/nsgmls.1  Thu Jan  1 01:00:00 1970
35 +++ jade-1.2.1.new/nsgmls/nsgmls.1      Tue Sep 21 22:48:19 1999
36 @@ -0,0 +1,1536 @@
37 +'\" t
38 +.tr \(ts"
39 +.ds S \s-1SGML\s0
40 +.de TS
41 +.br
42 +.sp .5
43 +..
44 +.de TE
45 +.br
46 +.sp .5
47 +..
48 +.de TQ
49 +.br
50 +.ns
51 +.TP \\$1
52 +..
53 +.TH NSGMLS 1
54 +.SH NAME
55 +nsgmls \- a validating SGML parser
56 +.sp
57 +An \*S System Conforming to
58 +.if n .br
59 +International Standard ISO 8879 \(em
60 +.br
61 +Standard Generalized Markup Language
62 +.SH SYNOPSIS
63 +.B nsgmls
64 +[
65 +.B \-Cdeglnprsuv
66 +]
67 +[
68 +.BI \-a linktype
69 +]
70 +[
71 +.BI \-b bctf
72 +]
73 +[
74 +.BI \-D directory
75 +]
76 +[
77 +.BI \-f file
78 +]
79 +[
80 +.BI \-i name
81 +]
82 +[
83 +.BI \-m sysid
84 +]
85 +[
86 +.BI \-o output_option
87 +]
88 +[
89 +.BI \-t file
90 +]
91 +[
92 +.BI \-w warning_type
93 +]
94 +[
95 +.IR sysid \|.\|.\|.
96 +]
97 +.SH DESCRIPTION
98 +This manual page may be out of date.  Consult the HTML documentation for
99 +the most up-to-date information concerning this program.
100 +.PP
101 +.I Nsgmls
102 +parses and validates
103 +the \*S document whose document entity is specified by the system identifiers
104 +.IR sysid \|.\|.\|.
105 +and prints on the standard output a simple text representation of its
106 +Element Structure Information Set.
107 +(This is the information set which a structure-controlled
108 +conforming \*S application should act upon.)
109 +The form of system identifiers is described in detail below;
110 +a system identifier that does not start with
111 +.B <
112 +and does not look like an absolute URL will be treated as a filename.
113 +If more than one system identifier is specified,
114 +then the corresponding entities will be concatenated to form
115 +the document entity.
116 +Thus the document entity may be spread amongst several files;
117 +for example, the SGML declaration, prolog and document
118 +instance set could each be in a separate file.
119 +If no system identifiers are specified, then
120 +.I nsgmls
121 +will read the document entity from the standard input.
122 +A command line system identifier of
123 +.B \-
124 +can be used to refer to the standard input.
125 +(Normally in a system identifier,
126 +.B <osfd>0
127 +is used to refer to standard input.)
128 +.LP
129 +The following options are available:
130 +.TP
131 +.BI \-a linktype
132 +Make link type
133 +.I linktype
134 +active.
135 +Not all ESIS information is output in this case:
136 +the active LPDs are not explicitly reported,
137 +although each link attribute is qualified with
138 +its link type name;
139 +there is no information about result elements;
140 +when there are multiple link rules applicable to the
141 +current element,
142 +.I nsgmls
143 +always chooses the first.
144 +.TP
145 +.BI \-b bctf
146 +Use the BCTF named
147 +.I bctf
148 +for output.
149 +See the description below of the
150 +.B bctf
151 +storage manager attribute for more information.
152 +.TP
153 +.B \-C
154 +The
155 +.IR filename \|.\|.\|.
156 +arguments specify catalog files rather than the document entity.
157 +The document entity is specified by the first
158 +.B DOCUMENT
159 +entry in the catalog files.
160 +.TP
161 +.BI \-D directory
162 +Search
163 +.I directory
164 +for files specified in system identifiers.
165 +Multiple
166 +.B \-D options
167 +are allowed.
168 +See the description of the
169 +.B osfile
170 +storage manager for more information about file searching.
171 +.TP
172 +.B \-e
173 +Describe open entities in error messages.
174 +Error messages always include the position of the most recently
175 +opened external entity.
176 +.TP
177 +.BI \-f file
178 +Redirect errors to
179 +.IR file .
180 +This is useful mainly with shells that do not support redirection
181 +of stderr.
182 +.TP
183 +.B \-g
184 +Show the \s-1GI\s0s of open elements in error messages.
185 +.TP
186 +.BI \-i name
187 +Pretend that
188 +.RS
189 +.IP
190 +.BI <!ENTITY\ %\  name\  \(tsINCLUDE\(ts>
191 +.LP
192 +occurs at the start of the document type declaration subset
193 +in the \*S document entity.
194 +Since repeated definitions of an entity are ignored,
195 +this definition will take precedence over any other definitions
196 +of this entity in the document type declaration.
197 +Multiple
198 +.B \-i
199 +options are allowed.
200 +If the \*S declaration replaces the reserved name
201 +.B INCLUDE
202 +then the new reserved name will be the replacement text of the entity.
203 +Typically the document type declaration will contain
204 +.IP
205 +.BI <!ENTITY\ %\  name\  \(tsIGNORE\(ts>
206 +.LP
207 +and will use
208 +.BI % name ;
209 +in the status keyword specification of a marked section declaration.
210 +In this case the effect of the option will be to cause the marked
211 +section not to be ignored.
212 +.RE
213 +.TP
214 +.BI \-m sysid
215 +Map public identifiers and entity names to system identifiers
216 +using the catalog entry file whose system identifier is
217 +.IR sysid .
218 +Multiple
219 +.B \-m
220 +options are allowed.
221 +If there is a catalog entry file called
222 +.B catalog
223 +in the same place as the document entity,
224 +it will be searched for immediately after those specified by
225 +.BR \-m .
226 +.TP
227 +.B \-n
228 +Generate system identifiers for notations.
229 +An
230 +.B f
231 +command will be output before each
232 +.B N
233 +command for a notation for which a system identifier could be generated.
234 +.TP
235 +.BI \-o output_option
236 +Output additional information accordig to
237 +.IR output_option :
238 +.RS
239 +.TP
240 +.B entity
241 +Output definitions of all general entities
242 +not just for data or subdoc entities that are referenced or named in an
243 +ENTITY or ENTITIES attribute.
244 +.TP
245 +.B id
246 +Distinguish attributes whose declared value is ID.
247 +.TP
248 +.B line
249 +Output
250 +.B L
251 +commands giving the current line number and filename.
252 +.TP
253 +.B included
254 +Output an
255 +.B i
256 +command for included subelements.
257 +.LP
258 +Multiple
259 +.B \-o
260 +options are allowed.
261 +.RE
262 +.TP
263 +.B \-p
264 +Parse only the prolog.
265 +.I Nsgmls
266 +will exit after parsing the document type declaration.
267 +Implies
268 +.BR \-s .
269 +.TP
270 +.B \-s
271 +Suppress output.
272 +Error messages will still be printed.
273 +.TP
274 +.BI \-t file
275 +Output to
276 +.I file
277 +the RAST result as defined by
278 +ISO/IEC 13673:1995 (actually this isn't quite an IS yet;
279 +this implements the Intermediate Editor's Draft of 1994/08/29,
280 +with changes to implement ISO/IEC JTC1/SC18/WG8 N1777).
281 +The normal output is not produced.
282 +.TP
283 +.B \-v
284 +Print the version number.
285 +.TP
286 +.BI \-w type
287 +Control warnings and errors.
288 +Multiple
289 +.B \-w
290 +options are allowed.
291 +The following values of
292 +.I type
293 +enable warnings:
294 +.RS
295 +.TP
296 +.B mixed
297 +Warn about mixed content models that do not allow #pcdata anywhere.
298 +.TP
299 +.B sgmldecl
300 +Warn about various dubious constructions in the SGML declaration.
301 +.TP
302 +.B should
303 +Warn about various recommendations made in ISO 8879 that the document
304 +does not comply with.
305 +(Recommendations are expressed with ``should'', as distinct from
306 +requirements which are usually expressed with ``shall''.)
307 +.TP
308 +.B default
309 +Warn about defaulted references.
310 +.TP
311 +.B duplicate
312 +Warn about duplicate entity declarations.
313 +.TP
314 +.B undefined
315 +Warn about undefined elements: elements used in the DTD but not defined.
316 +.TP
317 +.B unclosed
318 +Warn about unclosed start and end-tags.
319 +.TP
320 +.B empty
321 +Warn about empty start and end-tags.
322 +.TP
323 +.B net
324 +Warn about net-enabling start-tags and null end-tags.
325 +.TP
326 +.B min-tag
327 +Warn about minimized start and end-tags.
328 +Equivalent to combination of
329 +.BR unclosed ,
330 +.B empty
331 +and
332 +.B net
333 +warnings.
334 +.TP
335 +.B unused-map
336 +Warn about unused short reference maps: maps that are declared with a
337 +short reference mapping declaration but never used in a short
338 +reference use declaration in the DTD.
339 +.TP
340 +.B unused-param
341 +Warn about parameter entities that are defined but not used in a DTD.
342 +.TP
343 +.B all
344 +Warn about conditions that should usually be avoided
345 +(in the opinion of the author).
346 +Equivalent to:
347 +.BR mixed ,
348 +.BR should ,
349 +.BR default ,
350 +.BR undefined ,
351 +.BR sgmldecl ,
352 +.BR unused-map ,
353 +.BR unused-param ,
354 +.B empty
355 +and
356 +.BR unclosed .
357 +.LP
358 +A warning can be disabled by using its name prefixed with
359 +.BR no- .
360 +Thus
361 +.B -wall\ -wno-duplicate
362 +will enable all warnings except those about duplicate entity
363 +declarations.
364 +.LP
365 +The following values for
366 +.I warning_type
367 +disable errors:
368 +.TP
369 +.B no-idref
370 +Do not give an error for an ID reference value
371 +which no element has as its ID.
372 +The effect will be as if each attribute declared as
373 +an ID reference value had been declared as a name.
374 +.TP
375 +.B no-significant
376 +Do not give an error when a character that is not a significant
377 +character in the reference concrete syntax occurs in a literal in the
378 +SGML declaration.  This may be useful in conjunction with certain
379 +buggy test suites.
380 +.RE
381 +.LP
382 +The following options are also supported for backwards compatibility
383 +with
384 +.IR sgmls :
385 +.TP
386 +.B \-d
387 +Same as
388 +.BR \-wduplicate .
389 +.TP
390 +.B \-l
391 +Same as
392 +.BR \-oline .
393 +.TP
394 +.B \-r
395 +Same as
396 +.BR \-wdefault .
397 +.TP
398 +.B \-u
399 +Same as
400 +.BR \-wundef .
401 +.SS "System identifiers"
402 +A system identifier can either be a formal system identifier
403 +or a simple system identifier.
404 +A system identifier that is a formal system identifier
405 +consists of a sequence of one or more storage object specifications.
406 +The objects specified by the storage object specifications
407 +are concatenated to form the entity.
408 +A storage object specification consists of an SGML start-tag in the
409 +reference concrete syntax followed by character data content.
410 +The generic identifier of the start-tag is the name of a storage manager.
411 +The content is a storage object identifier which identifies
412 +the storage object in a manner dependent on the storage manager.
413 +The start-tag can also specify attributes giving additional information
414 +about the storage object.
415 +Numeric character references are recognized in storage object identifiers
416 +and attribute value literals in the start-tag.
417 +Record ends are ignored in the storage object identifier as with SGML.
418 +A system identifier will be interpreted as a formal system identifier
419 +if it starts with a
420 +.B <
421 +followed by a storage manager name, followed by
422 +either
423 +.B >
424 +or white-space;
425 +otherwise it will be interpreted as a simple system identifier.
426 +A storage object identifier extends until the end of the
427 +system identifier or until the first occurrence of
428 +.B <
429 +followed by a storage manager name, followed by
430 +either
431 +.B >
432 +or white-space.
433 +.LP
434 +The following storage managers are available:
435 +.TP
436 +.B osfile
437 +The storage object identifier is a filename.
438 +If the filename is relative it is resolved using
439 +a base filename.
440 +Normally the base filename is the name of
441 +the file in which the storage object identifier was
442 +specified, but this can be changed using the
443 +.B base
444 +attribute.
445 +The filename will be searched for first in the directory of
446 +the base filename.
447 +If it is not found there,
448 +then it will be searched for in directories specified with the
449 +.B \-D
450 +option in the order in which they were specified on the command line,
451 +and then in the list of directories
452 +specified by the environment variable
453 +.BR \s-1SGML_SEARCH_PATH\s0 .
454 +The list is separated by colons under Unix
455 +and by semi-colons under MSDOS.
456 +.TP
457 +.B osfd
458 +The storage object identifier is an integer specifying a file descriptor.
459 +Thus a system identifier of
460 +.B <osfd>0
461 +will refer to the standard input.
462 +.TP
463 +.B url
464 +The storage object identifier is a URL.
465 +Only the
466 +.B http
467 +scheme is currently supported and not on all systems.
468 +.TP
469 +.B neutral
470 +The storage manager is the storage manager of storage object
471 +in which the system identifier was specified
472 +(the
473 +.IR "underlying storage manager" ).
474 +However if the underlying storage manager does not support named
475 +storage objects (ie it is
476 +.BR osfd ),
477 +then the storage manager will be
478 +.BR osfile .
479 +The storage object identifier is treated as a relative, hierarchical
480 +name separated by slashes
481 +.RB ( / )
482 +and will be transformed as appropriate for the underlying storage manager.
483 +.LP
484 +The following attributes are supported:
485 +.TP
486 +.B records
487 +This describes how records are delimited in the storage object:
488 +.RS
489 +.TP
490 +.B cr
491 +Records are terminated by a carriage return.
492 +.TP
493 +.B lf
494 +Records are terminated by a line feed.
495 +.TP
496 +.B crlf
497 +Records are terminated by a carriage return followed by a line feed.
498 +.TP
499 +.B find
500 +Records are terminated by whichever of
501 +.BR cr ,
502 +.BR lf
503 +or
504 +.B crlf
505 +is first encountered in the storage object.
506 +.TP
507 +.B asis
508 +No recognition of records is performed.
509 +.LP
510 +The default is
511 +.B find
512 +except for NDATA entities for which the default is
513 +.BR asis .
514 +.LP
515 +When records are recognized in a storage object,
516 +a record start is inserted at the beginning of
517 +each record, and a record end at the end of each record.  If there is a
518 +partial record (a record that doesn't end with the record terminator)
519 +at the end of the entity, then a record start will be inserted before it
520 +but no record end will be inserted after it.
521 +.LP
522 +The attribute name and
523 +.B =
524 +can be omitted for this attribute.
525 +.RE
526 +.TP
527 +.B zapeof
528 +This specifies whether a Control-Z character that occurs as the final byte
529 +in the storage object should be stripped.
530 +The following values are allowed:
531 +.RS
532 +.TP
533 +.B zapeof
534 +A final Control-Z should be stripped.
535 +.TP
536 +.B nozapeof
537 +A final Control-Z should not be stripped.
538 +.LP
539 +The default is
540 +.B zapeof
541 +except for NDATA entities,
542 +entities declared in storage objects with
543 +.B zapeof=nozapeof
544 +and storage objects with
545 +.BR records=asis .
546 +.LP
547 +The attribute name and
548 +.B =
549 +can be omitted for this attribute.
550 +.RE
551 +.TP
552 +.B bctf
553 +The bctf (bit combination transformation format)
554 +attribute describes how the bit combinations of the
555 +storage object are transformed into the sequence of bytes
556 +that are contained in the object identified by the storage object identifier.
557 +This inverse of this transformation is performed when the entity manager
558 +reads the storage object.
559 +It has one of the following values:
560 +.RS
561 +.TP
562 +.B identity
563 +Each bit combination is represented by a single
564 +byte.
565 +.TP
566 +.B fixed-2
567 +Each bit combination is represented by exactly 2
568 +bytes, with the more significant byte first.
569 +.TP
570 +.B utf-8
571 +Each bit combination is represented by a variable
572 +number of bytes according to UCS Transformation
573 +Format 8 defined in Annex P to be added by the first
574 +proposed drafted amendment (PDAM 1) to ISO/IEC
575 + 10646-1:1993.
576 +.TP
577 +.B euc-jp
578 +Each bit combination is treated as a pair of bytes, most significant
579 +byte first, encoding a character using the
580 +Extended_UNIX_Code_Fixed_Width_for_Japanese Internet charset, and is
581 +transformed into the variable length sequence of octets that would
582 +encode that character using the
583 +Extended_UNIX_Code_Packed_Format_for_Japanese Internet charset.
584 +.TP
585 +.B sjis
586 +Each bit combination is treated as a pair of bytes, most significant
587 +byte first, encoding a character using the
588 +Extended_UNIX_Code_Fixed_Width_for_Japanese Internet charset, and is
589 +transformed into the variable length sequence of bytes that would
590 +encode that character using the Shift_JIS Internet charset.
591 +.TP
592 +.B unicode
593 +Each bit combination is represented by 2 bytes.
594 +The bytes representing the entire storage object may be preceded
595 +by a pair of bytes representing the byte order mark character (0xFEFF).
596 +The bytes representing each bit combination are in the system byte order,
597 +unless the byte order mark character is present, in which case
598 +the order of its bytes determines the byte order.
599 +When the storage object is read, any byte order mark character
600 +is discarded.
601 +.TP
602 +.BI is8859- N
603 +.I N
604 +can be any single digit other than 0.
605 +Each bit combination is interpreted as the number of a character
606 +in ISO/IEC 10646 and is represented by the single byte that would
607 +encode that character in ISO
608 +.RI 8859- N .
609 +These values are not supported with the
610 +.B \-b
611 +option.
612 +.LP
613 +Values other than
614 +.B identity
615 +are supported only with the multi-byte version of
616 +.IR nsgmls .
617 +.RE
618 +.TP
619 +.B tracking
620 +This specifies whether line boundaries should be tracked
621 +for this object:
622 +a value of
623 +.B track
624 +specifies that they should;
625 +a value of
626 +.B notrack
627 +specifies that they should not.
628 +The default value is
629 +.BR track .
630 +Keeping track of where line boundaries occur in a storage object
631 +requires approximately one byte of storage per line
632 +and it may be desirable to disable this for very large storage objects.
633 +.IP
634 +The attribute name and
635 +.B =
636 +can be omitted for this attribute.
637 +.TP
638 +.B base
639 +When the storage object identifier specified in the content of the
640 +storage object specification is relative, this specifies the base
641 +storage object identifier relative to which that storage object
642 +identifier should be resolved.
643 +When not specified a storage object identifier is interpreted
644 +relative to the storage object in which it is specified,
645 +provided that this has the same storage manager.
646 +This applies both to system identifiers specified in SGML
647 +documents and to system identifiers specified in the catalog entry
648 +files.
649 +.TP
650 +.B smcrd
651 +The value is a single character that will be recognized
652 +in storage object identifiers
653 +(both in the content of storage object specifications
654 +and in the value of
655 +.B base
656 +attributes)
657 +as a storage manager character reference delimiter
658 +when followed by a digit.
659 +A storage manager character reference is like an SGML numeric character
660 +reference except that the number is interpreted as a character number
661 +in the inherent character set of the storage manager rather than
662 +the document character set.
663 +The default is for no character to be recognized as
664 +a storage manager character reference delimiter.
665 +Numeric character references cannot be used to prevent
666 +recognition of storage manager character reference delimiters.
667 +.TP
668 +.B fold
669 +This applies only to the
670 +.B neutral
671 +storage manager.
672 +It specifies whether the storage object identifier should
673 +be folded to the customary case of the underlying storage manager
674 +if storage object identifiers for the underlying storage manager
675 +are case sensitive.
676 +The following values are allowed:
677 +.RS
678 +.TP
679 +.B fold
680 +The storage object identifier will be folded.
681 +.TP
682 +.B nofold
683 +The storage object identifier will not be folded.
684 +.LP
685 +The default value is
686 +.BR fold .
687 +The attribute name and
688 +.B =
689 +can be omitted for this attribute.
690 +.LP
691 +For example, on Unix filenames are case-sensitive and the customary
692 +case is lower-case.
693 +So if the underlying storage manager were
694 +.B osfile
695 +and the system was a Unix system, then
696 +.B \%<neutral>FOO.SGM
697 +would be equivalent to
698 +.BR \%<osfile>foo.sgm .
699 +.RE
700 +.LP
701 +A simple system identifier is interpreted as a storage object identifier
702 +with a storage manager that depends on where the system identifier
703 +was specified:
704 +if it was specified in a storage object whose storage manager was
705 +.B url
706 +or if the system identifier looks like an absolute URL in a supported scheme,
707 +the storage manager will be
708 +.BR url ;
709 +otherwise the storage manager will be
710 +.BR osfile .
711 +The storage manager attributes are defaulted as for a formal system
712 +identifier.
713 +Numeric character references are not recognized in simple system
714 +identifiers.
715 +.SS "System identifier generation"
716 +The entity manager generates an effective system identifier for every external
717 +entity using catalog entry files in the format defined
718 +by SGML Open Technical Resolution 9401:1994.
719 +The entity manager will give an error if it is unable to generate
720 +an effective system identifier for an external entity.
721 +Normally if the external identifier for an entity includes a system
722 +identifier then the entity manager will use that as the
723 +effective system identifier for
724 +the entity; this behaviour can be changed using OVERRIDE or SYSTEM
725 +entries in a catalog entry file.
726 +.LP
727 +A catalog entry file contains a
728 +sequence of entries in one of the following forms:
729 +.TP
730 +.BI PUBLIC\  pubid\ sysid
731 +This specifies that
732 +.I sysid
733 +should be used as the effective system identifier if the public
734 +identifier is
735 +.IR pubid .
736 +.I Sysid
737 +is a system identifier as defined in ISO 8879 and
738 +.I pubid
739 +is a public identifier as defined in ISO 8879.
740 +.TP
741 +.BI ENTITY\  name\ sysid
742 +This specifies that
743 +.I sysid
744 +should be used as the effective system identifier if the entity is a general
745 +entity whose name is
746 +.IR name .
747 +.TP
748 +.BI ENTITY\ % name\ sysid
749 +This specifies that
750 +.I sysid
751 +should be used as the effective system identifier if the entity is a parameter
752 +entity whose name is
753 +.IR name .
754 +Note that there is no space between the
755 +.B %
756 +and the
757 +.IR name .
758 +.TP
759 +.BI DOCTYPE\  name\ sysid
760 +This specifies that
761 +.I sysid
762 +should be used as the effective system identifier if the entity is an
763 +entity declared in a document type declaration whose document type name is
764 +.IR name .
765 +.TP
766 +.BI LINKTYPE\  name\ sysid
767 +This specifies that
768 +.I sysid
769 +should be used as the effective system identifier if the entity is an
770 +entity declared in a link type declaration whose link type name is
771 +.IR name .
772 +.TP
773 +.BI NOTATION\  name\ sysid
774 +This specifies that
775 +.I sysid
776 +should be used as the effective system identifier for a notation whose name is
777 +.IR name .
778 +This is an extension to the SGML Open format.
779 +This is relevant only with the
780 +.B \-n
781 +option.
782 +.TP
783 +.B OVERRIDE\ YES\fR|\fPNO
784 +This sets the overriding mode for entries up to the next
785 +occurrence of OVERRIDE or the end of the catalog entry file.
786 +At the beginning of a catalog entry file the overriding mode
787 +will be NO.
788 +A PUBLIC, ENTITY, DOCTYPE, LINKTYPE or NOTATION entry with an overriding
789 +mode of YES will be used whether or not the external identifier
790 +has an explicit system identifier;
791 +those with an overriding mode of NO will be ignored if
792 +external identifier has an explicit system identifier.
793 +This is an extension to the SGML Open format.
794 +.TP
795 +.BI SYSTEM\  sysid1\ sysid2
796 +This specifies that
797 +.I sysid2
798 +should be used as the effective system identifier if the system identifier
799 +specified in the external identifier was
800 +.IR sysid1 .
801 +This is an extension to the SGML Open format.
802 +.TP
803 +.BI SGMLDECL\  sysid
804 +This specifies that if the document does not contain an SGML declaration,
805 +the SGML declaration in
806 +.I sysid
807 +should be implied.
808 +.TP
809 +.BI DOCUMENT\  sysid
810 +This specifies that the document entity is
811 +.IR sysid .
812 +This entry is used only with the
813 +.B \-C
814 +option.
815 +.TP
816 +.BI CATALOG\  sysid
817 +This specifies that
818 +.I sysid
819 +is the system identifier of an additional catalog entry file to be
820 +read after this one.
821 +Multiple
822 +.B CATALOG
823 +entries are allowed and will be read in order.
824 +This is an extension to the SGML Open format.
825 +.LP
826 +The delimiters can be omitted from the
827 +.I sysid
828 +provided it does not contain any white space.
829 +Comments are allowed between parameters delimited by
830 +.B --
831 +as in SGML.
832 +.LP
833 +The environment variable
834 +.B \s-1SGML_CATALOG_FILES\s0
835 +contains a list of catalog entry files.
836 +The list is separated by colons under Unix
837 +and by semi-colons under MSDOS.
838 +These will be searched after any catalog entry files specified
839 +using the
840 +.B \-m
841 +option,
842 +and after the catalog entry file called
843 +.B catalog
844 +in the same place as the document entity.
845 +If this environment variable is not set,
846 +then a system dependent list of catalog entry files will be used.
847 +In fact catalog entry files are not restricted to being files:
848 +the name of a catalog entry file is interpreted as a system identifier.
849 +.LP
850 +A match in one catalog entry file will take precedence
851 +over any match in a later catalog entry file.
852 +A match in a catalog entry file for a SYSTEM entry will take
853 +precedence over a match in the same file for a PUBLIC, ENTITY,
854 +DOCTYPE, LINKTYPE or NOTATION entry.
855 +A match in a catalog entry file for a PUBLIC entry will take
856 +precedence over a match in the same file for an ENTITY,
857 +DOCTYPE, LINKTYPE or NOTATION entry.
858 +.br
859 +.ne 18
860 +.SS "System declaration"
861 +The system declaration for
862 +.I nsgmls
863 +is as follows:
864 +.LP
865 +.TS
866 +tab(&);
867 +c1 s1 s1 s1 s1 s1 s1 s1 s
868 +c s s s s s s s s
869 +l l s s s s s s s
870 +l l s s s s s s s
871 +l l s s s s s s s
872 +l l l s s s s s s
873 +c s s s s s s s s
874 +l l l l l l l l l
875 +l l l l l l l l l
876 +l l l l l l l l l
877 +l l s s s s s s s
878 +l l l s s s s s s
879 +l l l s s s s s s
880 +c s s s s s s s s
881 +l l l l l l l l l.
882 +SYSTEM "ISO 8879:1986"
883 +CHARSET
884 +BASESET&"ISO 646-1983//CHARSET
885 +&\h'\w'"'u'International Reference Version (IRV)//ESC 2/5 4/0"
886 +DESCSET&0\0128\00
887 +CAPACITY&PUBLIC&"ISO 8879:1986//CAPACITY Reference//EN"
888 +FEATURES
889 +MINIMIZE&DATATAG&NO&OMITTAG&YES&RANK&YES&SHORTTAG&YES
890 +LINK&SIMPLE&YES 65535&IMPLICIT&YES&EXPLICIT&YES 1
891 +OTHER&CONCUR&NO&SUBDOC&YES 100&FORMAL&YES
892 +SCOPE&DOCUMENT
893 +SYNTAX&PUBLIC&"ISO 8879:1986//SYNTAX Reference//EN"
894 +SYNTAX&PUBLIC&"ISO 8879:1986//SYNTAX Core//EN"
895 +VALIDATE
896 +&GENERAL&YES&MODEL&YES&EXCLUDE&YES&CAPACITY&NO
897 +&NONSGML&YES&SGML&YES&FORMAL&YES
898 +.T&
899 +c s s s s s s s s
900 +l l l l l l l l l.
901 +SDIF
902 +&PACK&NO&UNPACK&NO
903 +.TE
904 +.LP
905 +The limit for the \s-1SUBDOC\s0 parameter is memory dependent.
906 +.LP
907 +Any legal concrete syntax may be used.
908 +.SS "\*S declaration"
909 +If the \*S declaration is omitted
910 +and there is no applicable
911 +.B SGMLDECL
912 +entry in a catalog,
913 +the following declaration will be implied:
914 +.TS
915 +tab(&);
916 +c1 s1 s1 s1 s1 s1 s1 s1 s
917 +c s s s s s s s s
918 +l l s s s s s s s.
919 +<!SGML "ISO 8879:1986"
920 +CHARSET
921 +BASESET&"ISO 646-1983//CHARSET
922 +&\h'\w'"'u'International Reference Version (IRV)//ESC 2/5 4/0"
923 +DESCSET&\0\00\0\09\0UNUSED
924 +&\0\09\0\02\0\09
925 +&\011\0\02\0UNUSED
926 +&\013\0\01\013
927 +&\014\018\0UNUSED
928 +&\032\095\032
929 +&127\0\01\0UNUSED
930 +.T&
931 +l l l s s s s s s
932 +l l s s s s s s s.
933 +CAPACITY&PUBLIC&"ISO 8879:1986//CAPACITY Reference//EN"
934 +SCOPE&DOCUMENT
935 +SYNTAX
936 +SHUNCHAR&CONTROLS 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
937 +&18 19 20 21 22 23 24 25 26 27 28 29 30 31 127 255
938 +BASESET&"ISO 646-1983//CHARSET International Reference Version
939 +&\h'\w'"'u'(IRV)//ESC 2/5 4/0"
940 +DESCSET&0\0128\00
941 +.T&
942 +l l l l s s s s s.
943 +FUNCTION&RE&&13
944 +&RS&&10
945 +&SPACE&&32
946 +&TAB&SEPCHAR&9
947 +NAMING&LCNMSTRT&""
948 +&UCNMSTRT&""
949 +&LCNMCHAR&"-."
950 +&UCNMCHAR&"-."
951 +&NAMECASE&GENERAL&YES
952 +&&ENTITY&NO
953 +DELIM&GENERAL&SGMLREF
954 +&SHORTREF&SGMLREF
955 +NAMES&SGMLREF
956 +QUANTITY&SGMLREF
957 +&ATTCNT&99999999
958 +&ATTSPLEN&99999999
959 +&DTEMPLEN&24000
960 +&ENTLVL&99999999
961 +&GRPCNT&99999999
962 +&GRPGTCNT&99999999
963 +&GRPLVL&99999999
964 +&LITLEN&24000
965 +&NAMELEN&99999999
966 +&PILEN&24000
967 +&TAGLEN&99999999
968 +&TAGLVL&99999999
969 +.T&
970 +c s s s s s s s s
971 +l l l s s s s s s.
972 +FEATURES
973 +MINIMIZE&DATATAG&NO
974 +&OMITTAG&YES
975 +&RANK&YES
976 +&SHORTTAG&YES
977 +LINK&SIMPLE&YES\01000
978 +&IMPLICIT&YES
979 +&EXPLICIT&YES\01
980 +OTHER&CONCUR&NO
981 +&SUBDOC&YES\099999999
982 +&FORMAL&YES
983 +.T&
984 +c s s s s s s s s.
985 +APPINFO NONE>
986 +.TE
987 +with the exception that all characters that are neither significant
988 +not shunned will be assigned to \s-1DATACHAR\s0.
989 +.LP
990 +A character in a base character set is described either by giving its
991 +number in a universal character set, or by specifying a minimum
992 +literal.  The constraints on the choice of universal character set are
993 +that characters that are significant in the SGML reference concrete
994 +syntax must be in the universal character set and must have the same
995 +number in the universal character set as in ISO 646 and that each
996 +character in the character set must be represented by exactly one
997 +number; that character numbers in the range 0 to 31 and 127 to 159 are
998 +control characters (for the purpose of enforcing SHUNCHAR CONTROLS).
999 +It is recommended that ISO 10646 (Unicode) be used as the universal
1000 +character set, except in environments where the normal document
1001 +character sets are large character set which cannot be compactly
1002 +described in terms of ISO 10646.
1003 +The public identifier of a base character set can be associated
1004 +with an entity that describes it by using a
1005 +.B PUBLIC
1006 +entry in the catalog entry file.
1007 +The entity must be a fragment
1008 +of an SGML declaration
1009 +consisting of the
1010 +portion of a character set description,
1011 +following the DESCSET keyword,
1012 +that is, it must be a sequence of character descriptions,
1013 +where each character description specifies a described character
1014 +number, the number of characters and
1015 +either a character number in the universal character set, a minimum literal
1016 +or the keyword
1017 +.BR UNUSED .
1018 +Character numbers in the universal character set can be as big as
1019 +99999999.
1020 +.LP
1021 +In addition
1022 +.I nsgmls
1023 +has built in knowledge of a few character sets.
1024 +These are identified using the designating sequence in the
1025 +public identifier.  The following designating sequences are
1026 +recognized:
1027 +.TS
1028 +tab(&);
1029 +c c c c c
1030 +c c c c ^
1031 +c c c c ^
1032 +l n n n l.
1033 +Designating&ISO&Minimum&Number&Description
1034 +Escape&Registration&Character&of&
1035 +Sequence&Number&Number&Characters&
1036 +_
1037 +ESC 2/5 4/0&-&0&128&full set of ISO 646 IRV
1038 +ESC 2/8 4/0&2&0&128&G0 set of ISO 646 IRV
1039 +ESC 2/8 4/2&6&0&128&G0 set of ASCII
1040 +ESC 2/1 4/0&1&0&32&C0 set of ISO 646
1041 +.TE
1042 +.LP
1043 +The graphic character sets do not strictly include
1044 +C0 and C1 control character sets.
1045 +For convenience,
1046 +.I nsgmls
1047 +augments the graphic character sets with the appropriate
1048 +control character sets.
1049 +.LP
1050 +It is not necessary for every character set used in the SGML
1051 +declaration to be known to
1052 +.I nsgmls
1053 +provided that characters in the document character set that are
1054 +significant both in the reference concrete syntax and in the described
1055 +concrete syntax are described using known base character sets and that
1056 +characters that are significant in the described concrete syntax are
1057 +described using the same base character sets or the same minimum
1058 +literals in both the document character set description and the syntax
1059 +reference character set description.
1060 +.LP
1061 +The public identifier for a public concrete syntax can be associated
1062 +with an entity that describes using a
1063 +.B PUBLIC
1064 +entry in the catalog entry file.
1065 +The entity must be a fragment of an SGML declaration
1066 +consisting of a concrete syntax description
1067 +starting with the
1068 +.B SHUNCHAR
1069 +keyword
1070 +as in an SGML declaration.
1071 +The entity can also make use of the following extensions:
1072 +.IP
1073 +An
1074 +.I added\ function
1075 +can be expressed as a parameter literal
1076 +instead of a name.
1077 +.IP
1078 +The replacement for a reference reserved name
1079 +can be expressed as a parameter literal instead of a name.
1080 +.IP
1081 +The
1082 +.BR LCNMSTRT ,
1083 +.BR UCNMSTRT ,
1084 +.B LCNMCHAR
1085 +and
1086 +.B UCNMCHAR
1087 +keywords may each be followed by more than one parameter literal.  A
1088 +sequence of parameter literals has the same meaning as a single
1089 +parameter literal whose content is the concatenation of the content of
1090 +each of the literals in the sequence.  This extension is useful
1091 +because of the restriction on the length of a parameter literal in the
1092 +SGML declaration to 240 characters.
1093 +.IP
1094 +The total number of characters specified for
1095 +.B UCNMCHAR
1096 +or
1097 +.B UCNMSTRT
1098 +may exceed the total number of characters specified for
1099 +.B LCNMCHAR
1100 +or
1101 +.B LCNMSTRT
1102 +respectively.
1103 +Each character in
1104 +.B UCNMCHAR
1105 +or
1106 +.B UCNMSTRT
1107 +which does not have a corresponding character in the same position in
1108 +.B LCNMCHAR
1109 +or
1110 +.B LCNMSTRT
1111 +is simply assigned to UCNMCHAR or UCNMSTRT
1112 +without making it the upper-case form of any character.
1113 +.IP
1114 +A parameter following any of
1115 +.BR LCNMSTRT ,
1116 +.BR UCNMSTRT ,
1117 +.B LCNMCHAR
1118 +and
1119 +.B UCNMCHAR
1120 +keywords
1121 +may be followed by
1122 +the name token
1123 +.B .\|.\|.
1124 +and another parameter literal.
1125 +This has the same meaning as the two parameter literals
1126 +with a parameter literal in between
1127 +containing in order each character whose number
1128 +is greater than the number of the last character in
1129 +the first parameter literal and less than the
1130 +number of the first character in the second
1131 +parameter literal.
1132 +A parameter literal must contain at least one character for each
1133 +.B .\|.\|.
1134 +to which it is adjacent.
1135 +.IP
1136 +A number may be used as a parameter following the
1137 +.BR LCNMSTRT ,
1138 +.BR UCNMSTRT ,
1139 +.B LCNMCHAR
1140 +and
1141 +.B UCNMCHAR
1142 +keywords or as a delimiter in the
1143 +.B DELIM
1144 +section with the same meaning as a parameter literal
1145 +containing just a numeric character reference with that number.
1146 +.IP
1147 +The parameters following the
1148 +.BR LCNMSTRT ,
1149 +.BR UCNMSTRT ,
1150 +.B LCNMCHAR
1151 +and
1152 +.B UCNMCHAR
1153 +keywords may be omitted.
1154 +This has the same meaning as specifying
1155 +an empty parameter literal.
1156 +.IP
1157 +Within the specification of the short reference delimiters,
1158 +a parameter literal containing exactly one character
1159 +may be followed by the name token
1160 +.B .\|.\|.
1161 +and another parameter literal containing exactly one character.
1162 +This has the same meaning as a sequence of parameter literals
1163 +one for each character number that is greater than or equal
1164 +to the number of the character in the first parameter literal
1165 +and less than or equal to the number of the character in the
1166 +second parameter literal.
1167 +.LP
1168 +The public identifier for a public capacity set can be associated
1169 +with an entity that describes using a
1170 +.B PUBLIC
1171 +entry in the catalog entry file.
1172 +The entity must be a fragment of an SGML declaration
1173 +consisting of a sequence of capacity names and numbers.
1174 +.SS "Output format"
1175 +The output is a series of lines.
1176 +Lines can be arbitrarily long.
1177 +Each line consists of an initial command character
1178 +and one or more arguments.
1179 +Arguments are separated by a single space,
1180 +but when a command takes a fixed number of arguments
1181 +the last argument can contain spaces.
1182 +There is no space between the command character and the first argument.
1183 +Arguments can contain the following escape sequences.
1184 +.TP
1185 +.B \e\e
1186 +A
1187 +.BR \e.
1188 +.TP
1189 +.B \en
1190 +A record end character.
1191 +.TP
1192 +.B \e|
1193 +Internal \s-1SDATA\s0 entities are bracketed by these.
1194 +.TP
1195 +.BI \e nnn
1196 +The character whose code is
1197 +.I nnn
1198 +octal.
1199 +.LP
1200 +A record start character will be represented by
1201 +.BR \e012 .
1202 +Most applications will need to ignore
1203 +.B \e012
1204 +and translate
1205 +.B \en
1206 +into newline.
1207 +.TP
1208 +.BI \e# n ;
1209 +The character whose number is
1210 +.I n 
1211 +in decimal.
1212 +.I n
1213 +can have any number of digits.
1214 +This is used for characters that are not representable by the
1215 +encoding translation used for output
1216 +(as specified by the
1217 +.SM
1218 +.B NSGML_CODE
1219 +environment variable).
1220 +This will only occur with the multibyte version of nsgmls.
1221 +.LP
1222 +The possible command characters and arguments are as follows:
1223 +.TP
1224 +.BI ( gi
1225 +The start of an element whose generic identifier is
1226 +.IR gi .
1227 +Any attributes for this element
1228 +will have been specified with
1229 +.B A
1230 +commands.
1231 +.TP
1232 +.BI ) gi
1233 +The end of an element whose generic identifier is
1234 +.IR gi .
1235 +.TP
1236 +.BI \- data
1237 +Data.
1238 +.TP
1239 +.BI & name
1240 +A reference to an external data entity
1241 +.IR name ;
1242 +.I name
1243 +will have been defined using an
1244 +.B E
1245 +command.
1246 +.TP
1247 +.BI ? pi
1248 +A processing instruction with data
1249 +.IR pi .
1250 +.TP
1251 +.BI A name\ val
1252 +The next element to start has an attribute
1253 +.I name
1254 +with value
1255 +.I val
1256 +which takes one of the following forms:
1257 +.RS
1258 +.TP
1259 +.B IMPLIED
1260 +The value of the attribute is implied.
1261 +.TP
1262 +.BI CDATA\  data
1263 +The attribute is character data.
1264 +This is used for attributes whose declared value is
1265 +.BR \s-1CDATA\s0 .
1266 +.TP
1267 +.BI NOTATION\  nname
1268 +The attribute is a notation name;
1269 +.I nname
1270 +will have been defined using a
1271 +.B N
1272 +command.
1273 +This is used for attributes whose declared value is
1274 +.BR \s-1NOTATION\s0 .
1275 +.TP
1276 +.BI ENTITY\  name\|.\|.\|.
1277 +The attribute is a list of general entity names.
1278 +Each entity name will have been defined using an
1279 +.BR I ,
1280 +.B E
1281 +or
1282 +.B S
1283 +command.
1284 +This is used for attributes whose declared value is
1285 +.B \s-1ENTITY\s0
1286 +or
1287 +.BR \s-1ENTITIES\s0 .
1288 +.TP
1289 +.BI TOKEN\  token\|.\|.\|.
1290 +The attribute is a list of tokens.
1291 +This is used for attributes whose declared value is anything else.
1292 +.TP
1293 +.BI ID\  token
1294 +The attribute is an ID value.
1295 +This will be output only if the
1296 +.B \-oid
1297 +option is specified.
1298 +Otherwise
1299 +.B TOKEN
1300 +will be used for ID values.
1301 +.RE
1302 +.TP
1303 +.BI D ename\ name\ val
1304 +This is the same as the
1305 +.B A
1306 +command, except that it specifies a data attribute for an
1307 +external entity named
1308 +.IR ename .
1309 +Any
1310 +.B D
1311 +commands will come after the
1312 +.B E
1313 +command that defines the entity to which they apply, but
1314 +before any
1315 +.B &
1316 +or
1317 +.B A
1318 +commands that reference the entity.
1319 +.TP
1320 +.BI a type\ name\ val
1321 +The next element to start has a link attribute with link type
1322 +.IR type ,
1323 +name
1324 +.IR name ,
1325 +and value
1326 +.IR val ,
1327 +which takes the same form as with the
1328 +.B A
1329 +command.
1330 +.TP
1331 +.BI N nname
1332 +.IR nname.
1333 +Define a notation.
1334 +This command will be preceded by a
1335 +.B p
1336 +command if the notation was declared with a public identifier,
1337 +and by a
1338 +.B s
1339 +command if the notation was declared with a system identifier.
1340 +If the
1341 +.B \-n
1342 +option was specified,
1343 +this command will also be preceded by an
1344 +.B f
1345 +command giving the system identifier generated by the entity manager
1346 +(unless it was unable to generate one).
1347 +A notation will only be defined if it is to be referenced
1348 +in an
1349 +.B E
1350 +command or in an
1351 +.B A
1352 +command for an attribute with a declared value of
1353 +.BR \s-1NOTATION\s0 .
1354 +.TP
1355 +.BI E ename\ typ\ nname
1356 +Define an external data entity named
1357 +.I ename
1358 +with type
1359 +.I typ
1360 +.RB ( \s-1CDATA\s0 ,
1361 +.B \s-1NDATA\s0
1362 +or
1363 +.BR \s-1SDATA\s0 )
1364 +and notation
1365 +.IR not.
1366 +This command will be preceded by an
1367 +.B f
1368 +command giving the system identifier generated by the entity manager
1369 +(unless it was unable to generate one),
1370 +by a
1371 +.B p
1372 +command if a public identifier was declared for the entity,
1373 +and by a
1374 +.B s
1375 +command if a system identifier was declared for the entity.
1376 +.I not
1377 +will have been defined using a
1378 +.B N
1379 +command.
1380 +Data attributes may be specified for the entity using
1381 +.B D
1382 +commands.
1383 +If the
1384 +.B \-oentity
1385 +option is not specified,
1386 +an external data entity will only be defined if it is to be referenced in a
1387 +.B &
1388 +command or in an
1389 +.B A
1390 +command for an attribute whose declared value is
1391 +.B \s-1ENTITY\s0
1392 +or
1393 +.BR \s-1ENTITIES\s0 .
1394 +.TP
1395 +.BI I ename\ typ\ text
1396 +Define an internal data entity named
1397 +.I ename
1398 +with type
1399 +.I typ
1400 +and entity text
1401 +.IR text .
1402 +The
1403 +.I typ
1404 +will be
1405 +.B \s-1CDATA\s0
1406 +or
1407 +.B \s-1SDATA\s0
1408 +unless the
1409 +.B \-oentity
1410 +option was specified,
1411 +in which case it can also be
1412 +.B \s-1PI\s0
1413 +or
1414 +.B \s-1TEXT\s0
1415 +(for an \*S text entity).
1416 +If the
1417 +.B \-oentity
1418 +option is not specified,
1419 +an internal data entity will only be defined if it is referenced in an
1420 +.B A
1421 +command for an attribute whose declared value is
1422 +.B \s-1ENTITY\s0
1423 +or
1424 +.BR \s-1ENTITIES\s0 .
1425 +.TP
1426 +.BI S ename
1427 +Define a subdocument entity named
1428 +.IR ename .
1429 +This command will be preceded by an
1430 +.B f
1431 +command giving the system identifier generated by the entity manager
1432 +(unless it was unable to generate one),
1433 +by a
1434 +.B p
1435 +command if a public identifier was declared for the entity,
1436 +and by a
1437 +.B s
1438 +command if a system identifier was declared for the entity.
1439 +If the
1440 +.B \-oentity
1441 +option is not specified,
1442 +a subdocument entity will only be defined if it is referenced
1443 +in a
1444 +.B {
1445 +command
1446 +or in an
1447 +.B A
1448 +command for an attribute whose declared value is
1449 +.B \s-1ENTITY\s0
1450 +or
1451 +.BR \s-1ENTITIES\s0 .
1452 +.TP
1453 +.BI T ename
1454 +Define an external SGML text entity named
1455 +.IR ename .
1456 +This command will be preceded by an
1457 +.B f
1458 +command giving the system identifier generated by the entity manager
1459 +(unless it was unable to generate one),
1460 +by a
1461 +.B p
1462 +command if a public identifier was declared for the entity,
1463 +and by a
1464 +.B s
1465 +command if a system identifier was declared for the entity.
1466 +This command will be output only if the
1467 +.B \-oentity
1468 +option is specified.
1469 +.TP
1470 +.BI s sysid
1471 +This command applies to the next
1472 +.BR E ,
1473 +.BR S ,
1474 +.B T
1475 +or
1476 +.B N
1477 +command and specifies the associated system identifier.
1478 +.TP
1479 +.BI p pubid
1480 +This command applies to the next
1481 +.BR E ,
1482 +.BR S ,
1483 +.B T
1484 +or
1485 +.B N
1486 +command and specifies the associated public identifier.
1487 +.TP
1488 +.BI f sysid
1489 +This command applies to the next
1490 +.BR E ,
1491 +.BR S ,
1492 +.B T
1493 +or, if the
1494 +.B \-n
1495 +option was specified,
1496 +.B N
1497 +command and specifies the system identifier
1498 +generated by the entity manager from the specified external identifier
1499 +and other information about the entity or notation.
1500 +.TP
1501 +.BI { ename
1502 +The start of the \*S subdocument entity
1503 +.IR ename ;
1504 +.I ename
1505 +will have been defined using a
1506 +.B S
1507 +command.
1508 +.TP
1509 +.BI } ename
1510 +The end of the \*S subdocument entity
1511 +.IR ename .
1512 +.TP
1513 +.BI L lineno\ file
1514 +.TQ
1515 +.BI L lineno
1516 +Set the current line number and filename.
1517 +The
1518 +.I file
1519 +argument will be omitted if only the line number has changed.
1520 +This will be output only if the
1521 +.B \-l
1522 +option has been given.
1523 +.TP
1524 +.BI # text
1525 +An \s-1APPINFO\s0 parameter of
1526 +.I text
1527 +was specified in the \*S declaration.
1528 +This is not strictly part of the ESIS, but a structure-controlled
1529 +application is permitted to act on it.
1530 +No
1531 +.B #
1532 +command will be output if
1533 +.B \s-1APPINFO\s0\ \s-1NONE\s0
1534 +was specified.
1535 +A
1536 +.B #
1537 +command will occur at most once,
1538 +and may be preceded only by a single
1539 +.B L
1540 +command.
1541 +.TP
1542 +.B C
1543 +This command indicates that the document was a conforming \*S document.
1544 +If this command is output, it will be the last command.
1545 +An \*S document is not conforming if it references a subdocument entity
1546 +that is not conforming.
1547 +.SH ENVIRONMENT
1548 +.TP
1549 +.SM
1550 +.B SP_BCTF
1551 +If this is set to one of
1552 +.BR identity ,
1553 +.BR utf-8 ,
1554 +.B euc-jp
1555 +and
1556 +.BR sjis ,
1557 +then that BCTF will be used as the default BCTF
1558 +for everything (including file input, file output, message output,
1559 +filenames and command line arguments).
1560 +.SH "SEE ALSO"
1561 +The \*S Handbook, Charles F. Goldfarb
1562 +.br
1563 +\s-1ISO\s0 8879 (Standard Generalized Markup Language),
1564 +International Organization for Standardization
1565 +.SH BUGS
1566 +.LP
1567 +Only with
1568 +.B \-t
1569 +is all ESIS information for LINK is reported.
1570 +.SH AUTHOR
1571 +.LP
1572 +James Clark (jjc@jclark.com).
1573 diff -Nru jade-1.2.1/spam/spam.1 jade-1.2.1.new/spam/spam.1
1574 --- jade-1.2.1/spam/spam.1      Thu Jan  1 01:00:00 1970
1575 +++ jade-1.2.1.new/spam/spam.1  Tue Sep 21 22:48:19 1999
1576 @@ -0,0 +1,259 @@
1577 +.tr \(ts"
1578 +.ds S \s-1SGML\s0
1579 +.TH SPAM 1
1580 +.SH NAME
1581 +spam \- an SGML markup stream editor
1582 +.sp
1583 +An \*S System Conforming to
1584 +.if n .br
1585 +International Standard ISO 8879 \(em
1586 +.br
1587 +Standard Generalized Markup Language
1588 +.SH SYNOPSIS
1589 +.B spam
1590 +[
1591 +.B \-ehilprvx
1592 +]
1593 +[
1594 +.BI \-c catalog_file
1595 +]
1596 +[
1597 +.BI \-D directory
1598 +]
1599 +[
1600 +.BI \-f file
1601 +]
1602 +[
1603 +.BI \-m markup_option
1604 +]
1605 +[
1606 +.BI \-o entity_name
1607 +]
1608 +[
1609 +.BI \-w warning_type
1610 +]
1611 +.I sysid\|.\|.\|.
1612 +.SH DESCRIPTION
1613 +This manual page may be out of date.  Consult the HTML documentation for
1614 +the most up-to-date information concerning this program.
1615 +.PP
1616 +.I Spam
1617 +(SP Add Markup)
1618 +is an SGML markup stream editor implemented using the SP parser.
1619 +.I Spam
1620 +parses the SGML document contained in
1621 +.I sysid\|.\|.\|.
1622 +and copies to the standard output
1623 +the portion of the document entity containing the document
1624 +instance, adding or changing markup as specified by the
1625 +.B \-m
1626 +options.
1627 +The
1628 +.B \-p
1629 +option can be used to include the SGML declaration and prolog
1630 +in the output.
1631 +The
1632 +.B \-o
1633 +option can be used to output other entities.
1634 +The
1635 +.B \-x
1636 +option can be used to expand entity references.
1637 +.LP
1638 +For more information about the underlying SGML parser and entity
1639 +manager, see
1640 +.BR nsgmls (1).
1641 +.LP
1642 +The following options are available:
1643 +.TP
1644 +.BI \-c file
1645 +Use the catalog entry file
1646 +.IR file .
1647 +.TP
1648 +.BI \-D directory
1649 +Search
1650 +.I directory
1651 +for files specified in system identifiers.
1652 +Multiple
1653 +.B \-D
1654 +options are allowed.
1655 +See
1656 +.BR nsgmls (1)
1657 +for more information about file searching.
1658 +.TP
1659 +.B \-e
1660 +Describe open entities in error messages.
1661 +.TP
1662 +.BI \-f file
1663 +Redirect errors to
1664 +.IR file .
1665 +This is useful mainly with shells that do not support redirection
1666 +of stderr.
1667 +.TP
1668 +.B \-h
1669 +Hoist omitted tags out from the start of internal entities.
1670 +If the text at the beginning of an internal entity causes
1671 +a tag to be implied,
1672 +the tag will usually be treated as being in that internal entity;
1673 +this option will instead cause it to be treated as being in the entity
1674 +that referenced the internal entity.
1675 +This option makes a difference in conjunction with
1676 +.B \-momittag
1677 +or
1678 +.BR \-x\ \-x .
1679 +.TP
1680 +.BI \-i name
1681 +Pretend that
1682 +.RS
1683 +.IP
1684 +.BI <!ENTITY\ %\  name\  \(tsINCLUDE\(ts>
1685 +.LP
1686 +occurs at the start of the document type declaration subset
1687 +in the \*S document entity.
1688 +.RE
1689 +.TP
1690 +.BI \-l
1691 +Prefer lower-case.
1692 +Added names that were subject to upper-case substitution
1693 +will be converted to lower-case.
1694 +.TP
1695 +.BI \-m markup_option
1696 +Change the markup in the output according to the value
1697 +of
1698 +.I markup_option
1699 +as follows:
1700 +.RS
1701 +.TP
1702 +.B omittag
1703 +Add tags that were omitted using omitted tag minimization.
1704 +End tags that were omitted because the element has
1705 +a declared content of
1706 +.SM EMPTY
1707 +or an explicit content reference
1708 +will not be added.
1709 +.TP
1710 +.B shortref
1711 +Replace short references by named entity references.
1712 +.TP
1713 +.B net
1714 +Change null end-tags
1715 +into unminimized end-tags,
1716 +and change net-enabling start-tags
1717 +into unminimized start-tags.
1718 +.TP
1719 +.B emptytag
1720 +Change empty tags into unminimized tags.
1721 +.TP
1722 +.B unclosed
1723 +Change unclosed tags into unminimized tags.
1724 +.TP
1725 +.B attname
1726 +Add omitted attribute names and
1727 +.BR vi s.
1728 +.TP
1729 +.B attvalue
1730 +Add literal delimiters omitted from attribute values.
1731 +.TP
1732 +.B attspec
1733 +Add omitted attribute specifications.
1734 +.TP
1735 +.B current
1736 +Add omitted attribute specifications for current attributes.
1737 +This option is implied by the
1738 +.B attspec
1739 +option.
1740 +.TP
1741 +.B shorttag
1742 +Equivalent to combination of
1743 +.BR net ,
1744 +.BR emptytag ,
1745 +.BR unclosed ,
1746 +.BR attname ,
1747 +.B attvalue
1748 +and
1749 +.B attspec
1750 +options.
1751 +.TP
1752 +.B rank
1753 +Add omitted rank suffixes.
1754 +.TP
1755 +.B reserved
1756 +Put reserved names in upper-case.
1757 +.TP
1758 +.B ms
1759 +Remove marked section declarations whose effective status
1760 +is IGNORE, and replace each marked section declaration
1761 +whose effective status is INCLUDE by its marked section.
1762 +In the document instance, empty comments will be added
1763 +before or after the marked section declaration to ensure
1764 +that ignored record ends remain ignored.
1765 +.LP
1766 +Multiple
1767 +.B \-m
1768 +options are allowed.
1769 +.RE
1770 +.TP
1771 +.BI \-o name
1772 +Output the general entity
1773 +.I name
1774 +instead of the document entity.
1775 +The output will correspond to the first time
1776 +that the entity is referenced in content.
1777 +.TP
1778 +.B \-p
1779 +Output the part of the document entity containing the SGML declaration
1780 +(if it was explicitly present in the document entity)
1781 +and the prolog before anything else.
1782 +If this option is specified two or more times,
1783 +then all entity references occurring between declarations
1784 +in the prolog will be expanded;
1785 +this includes the implicit reference to the entity
1786 +containing the external subset of the DTD, if there is one.
1787 +Note that the SGML declaration will not be included if it was
1788 +specified by an SGMLDECL entry in a catalog.
1789 +.TP
1790 +.B \-r
1791 +Don't perform any conversion on RSs and REs when outputting the entity.
1792 +The entity would typically have the storage manager attribute
1793 +.BR records=asis .
1794 +.TP
1795 +.B \-v
1796 +Print the version number.
1797 +.TP
1798 +.BI \-w type
1799 +Control warnings and errors according to
1800 +.IR type .
1801 +See
1802 +.BR nsgmls (1)
1803 +for the allowed values of
1804 +.IR type .
1805 +.TP
1806 +.B \-x
1807 +Expand references to entities that are changed.
1808 +If this option is specified two or more times,
1809 +then all references to entities that contain tags
1810 +will be expanded.
1811 +.SH BUGS
1812 +.LP
1813 +Omitted tags are added at the point where they are
1814 +implied by the SGML parser (except as modified
1815 +by the
1816 +.B \-h
1817 +option); this is often not quite where they are wanted.
1818 +.LP
1819 +The case of general delimiters is not preserved.
1820 +.LP
1821 +Incorrect results may be produced if a variant concrete syntax is used
1822 +which is such that there are delimiters in markup to be added that have a
1823 +prefix that is a proper suffix of some other delimiter.
1824 +.LP
1825 +If an entity reference in a default value uses the default entity and
1826 +an entity with that name is subsequently defined and that default
1827 +value is added to the document instance, then the resulting document
1828 +may not be equivalent to the original document.
1829 +.I Spam
1830 +will give a warning when the first two conditions are met.
1831 +.SH AUTHOR
1832 +.LP
1833 +James Clark (jjc@jclark.com).
1834 +.SH "SEE ALSO"
1835 +.BR nsgmls (1)
1836 diff -Nru jade-1.2.1/spent/spent.1 jade-1.2.1.new/spent/spent.1
1837 --- jade-1.2.1/spent/spent.1    Thu Jan  1 01:00:00 1970
1838 +++ jade-1.2.1.new/spent/spent.1        Tue Sep 21 22:48:19 1999
1839 @@ -0,0 +1,45 @@
1840 +.TH SPENT 1
1841 +.SH NAME
1842 +spent \- print SGML entity on the standard output
1843 +.SH SYNOPSIS
1844 +.B spent
1845 +[
1846 +.B \-rv
1847 +]
1848 +[
1849 +.BI \-b bctf
1850 +]
1851 +.I sysid\|.\|.\|.
1852 +.SH DESCRIPTION
1853 +This manual page may be out of date.  Consult the HTML documentation for
1854 +the most up-to-date information concerning this program.
1855 +.PP
1856 +.I Spent
1857 +(SGML print entity)
1858 +prints the concatenation of the entities with system identifiers
1859 +.I sysid\|.\|.\|.
1860 +on the standard output.
1861 +The format of the system identifiers is described in
1862 +.BR nsgmls (1).
1863 +.LP
1864 +The following options are available:
1865 +.TP
1866 +.BI \-b bctf
1867 +Use the BCTF with name
1868 +.I bctf
1869 +for output.
1870 +Available BCTFs are described in
1871 +.BR nsgmls (1).
1872 +.TP
1873 +.B \-r
1874 +Don't perform any conversion on RSs and REs when printing the entity.
1875 +The entity would typically have the storage manager attribute
1876 +.BR records=asis .
1877 +.TP
1878 +.B \-v
1879 +Print the version number.
1880 +.SH AUTHOR
1881 +.LP
1882 +James Clark (jjc@jclark.com).
1883 +.SH "SEE ALSO"
1884 +.BR nsgmls (1)
This page took 0.460428 seconds and 3 git commands to generate.