< draft-lilly-text-troff-03.txt   draft-lilly-text-troff-04.txt >
Network Working Group B. Lilly Network Working Group B. Lilly
Intended status: Informational Intended status: Informational
Expires: November 12, 2005 Expires: November 28, 2005
Media subtype registration for media type text/troff Media subtype registration for media type text/troff
draft-lilly-text-troff-03 draft-lilly-text-troff-04
Status of this Memo Status of this Memo
By submitting this Internet-Draft, each author represents that any By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79. aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
skipping to change at page 2, line 21 skipping to change at page 2, line 21
5. Acknowledgments................................................ 8 5. Acknowledgments................................................ 8
6. Security Considerations........................................ 8 6. Security Considerations........................................ 8
7. Internationalization Considerations............................ 8 7. Internationalization Considerations............................ 8
8. IANA Considerations............................................ 9 8. IANA Considerations............................................ 9
Appendix A. Examples.............................................. 9 Appendix A. Examples.............................................. 9
A.1. Data Format............................................... 9 A.1. Data Format............................................... 9
A.2. Simple Diagram............................................ 10 A.2. Simple Diagram............................................ 10
Appendix B. Disclaimers........................................... 11 Appendix B. Disclaimers........................................... 11
Appendix C. Change History........................................ 11 Appendix C. Change History........................................ 11
Normative References.............................................. 12 Normative References.............................................. 12
Informative References............................................ 12 Informative References............................................ 13
Author's Address.................................................. 14 Author's Address.................................................. 14
1. Introduction 1. Introduction
It is sometimes desirable to format text in a particular way for It is sometimes desirable to format text in a particular way for
presentation. One approach is to provide formatting directives in presentation. One approach is to provide formatting directives in
juxtaposition to the text to be formatted. That approach permits juxtaposition to the text to be formatted. That approach permits
reading the text in unformatted form (by ignoring the formatting reading the text in unformatted form (by ignoring the formatting
directives), and it permits relatively simple repurposing of the text directives), and it permits relatively simple repurposing of the text
for different media by making suitable alterations to the formatting for different media by making suitable alterations to the formatting
skipping to change at page 4, line 33 skipping to change at page 4, line 33
text, and which is not readily comprehensible from a textual text, and which is not readily comprehensible from a textual
description of the graphical elements, a subtype of the image media description of the graphical elements, a subtype of the image media
type would be appropriate. The purpose of labeling media content is type would be appropriate. The purpose of labeling media content is
to provide information about that content to facilitate use of the to provide information about that content to facilitate use of the
content. Use of a particular label requires some common sense and content. Use of a particular label requires some common sense and
judgment, and SHOULD NOT be mechanically applied to content in the judgment, and SHOULD NOT be mechanically applied to content in the
absence of such judgment. absence of such judgment.
4. Registration Form 4. Registration Form
The registration procedure and form are specified in [I3.BCP13].
Type name: text Type name: text
Subtype name: troff Subtype name: troff
Required parameters: none Required parameters: none
Optional parameters: Optional parameters:
charset: Must be a charset registered for use with MIME text types charset: Must be a charset registered for use with MIME text types
[N3.RFC2046], except where transport protocols are explicitly [N3.RFC2046], except where transport protocols are explicitly
skipping to change at page 5, line 30 skipping to change at page 5, line 32
canonicalized per [N3.RFC2046]. Transfer of this media type canonicalized per [N3.RFC2046]. Transfer of this media type
content via some transport mechanisms may require or benefit content via some transport mechanisms may require or benefit
from encoding into a 7bit range via a suitable encoding method from encoding into a 7bit range via a suitable encoding method
such as the ones described in [N4.RFC2045]. In particular, such as the ones described in [N4.RFC2045]. In particular,
some lines in this media type might begin or end with some lines in this media type might begin or end with
whitespace, and that leading and/or trailing whitespace might whitespace, and that leading and/or trailing whitespace might
be discarded or otherwise mangled if the media type is not be discarded or otherwise mangled if the media type is not
encoded for transport. encoded for transport.
8bit may be used with Unicode characters represented as a series 8bit may be used with Unicode characters represented as a series
of octets using the utf-8 charset [I3.RFC3629], where transport of octets using the utf-8 charset [I4.RFC3629], where transport
methods permit 8bit content and where content line length is methods permit 8bit content and where content line length is
suitable. Transport encoding considerations for robustness may suitable. Transport encoding considerations for robustness may
also apply, and if a suitable 8bit encoding mechanism is also apply, and if a suitable 8bit encoding mechanism is
standardized, it might be applicable for protection of media standardized, it might be applicable for protection of media
during transport. during transport.
binary may be necessary when raw Unicode is used or where line binary may be necessary when raw Unicode is used or where line
lengths exceed the allowable maximum for 7bit and 8bit content lengths exceed the allowable maximum for 7bit and 8bit content
[N4.RFC2045], and may be used in environments (e.g. HTTP [N4.RFC2045], and may be used in environments (e.g. HTTP
[I4.RFC2616]) where Unicode characters may be transferred via a [I5.RFC2616]) where Unicode characters may be transferred via a
non-MIME charset such as UTF-16 [I5.RFC2781]. non-MIME charset such as UTF-16 [I6.RFC2781].
Restrictions on usage: none Restrictions on usage: none
Security considerations: Some troff directives (.sy and .pi) can Security considerations: Some troff directives (.sy and .pi) can
cause arbitrary external programs to be run. Several troff cause arbitrary external programs to be run. Several troff
directives (.so, .nx, and .cf) may read external files (and/or directives (.so, .nx, and .cf) may read external files (and/or
devices on systems which support device input via file system devices on systems which support device input via file system
semantics) during processing. Several preprocessors have similar semantics) during processing. Several preprocessors have similar
features. Some implementations have a "safe" mode which disables features. Some implementations have a "safe" mode which disables
some of these features. Formatters and preprocessors are some of these features. Formatters and preprocessors are
skipping to change at page 6, line 17 skipping to change at page 6, line 19
preprocessors and/or postprocessors SHOULD NOT be invoked preprocessors and/or postprocessors SHOULD NOT be invoked
automatically (i.e. w/o user confirmation). In some cases, as automatically (i.e. w/o user confirmation). In some cases, as
this is a text media type (i.e. it contains text which is this is a text media type (i.e. it contains text which is
comprehensible without processing), it may be sufficient to comprehensible without processing), it may be sufficient to
present the media type with no processing at all. However, like present the media type with no processing at all. However, like
any other text media, this media type may contain control any other text media, this media type may contain control
characters, and implementers SHOULD take precautions against characters, and implementers SHOULD take precautions against
untoward consequences of sending raw control characters to display untoward consequences of sending raw control characters to display
devices. devices.
A command line, such as may be suggested via the optional Users of this media type SHOULD carefully scrutinize suggested
"process" parameter, is a powerful tool when used by a command lines associated with the "process" parameter, contained
computer-literate person. Individuals lacking basic security in comments within the media, or conveyed via external mechanisms,
knowledge and/or common sense SHOULD NOT be given unsupervised both for attempts at social engineering and for the effects of
access to a command line. Users of this media type SHOULD ill-considered values of the parameter. While some
carefully scrutinize the suggested command pipeline and media implementations may have "safe" modes, those using this media type
content before executing commands. MUST NOT presume that they are available or active.
Comments may be included in troff source; comments are not Comments may be included in troff source; comments are not
formatted for output. However, they are of course readable in the formatted for output. However, they are of course readable in the
troff document source. Authors should be careful about troff document source. Authors should be careful about
information placed in comments, as such information may result in information placed in comments, as such information may result in
a leak of information, or may have other undesirable consequences. a leak of information, or may have other undesirable consequences.
While it is possible to overlay text with graphics or otherwise While it is possible to overlay text with graphics or otherwise
produce formatting instructions that would visually obscure text produce formatting instructions that would visually obscure text
when formatted, such measures do not prevent extracting text from when formatted, such measures do not prevent extracting text from
skipping to change at page 7, line 40 skipping to change at page 7, line 34
characters might be produced by overstriking, italics might be characters might be produced by overstriking, italics might be
represented by underlining, etc. represented by underlining, etc.
Various systems store text with different line ending codings. Various systems store text with different line ending codings.
For the purpose of transferring this media type between systems or For the purpose of transferring this media type between systems or
between applications using MIME methods, line endings MUST use the between applications using MIME methods, line endings MUST use the
canonical CRLF line ending per [N3.RFC2046]. canonical CRLF line ending per [N3.RFC2046].
Published specification: [N1.CSTR54] Published specification: [N1.CSTR54]
Applications which use this media type: Applications which use this media type: The following applications in
each sub-category are examples. The lists are not intended to be
exhaustive.
Preprocessors: tbl [I6.CSTR49], grap [I7.CSTR114], pic Preprocessors: tbl [I7.CSTR49], grap [I8.CSTR114], pic
[I8.CSTR116], chem [I9.CSTR122], eqn [I10.eqn], dformat [I9.CSTR116], chem [I10.CSTR122], eqn [I11.eqn], dformat
[I11.CSTR142] [I12.CSTR142]
Formatters: troff, nroff, Eroff, sqtroff, groff, awf, cawf Formatters: troff, nroff, Eroff, sqtroff, groff, awf, cawf
Format converters: deroff, troffcvt, unroff, troff2html, mm2html Format converters: deroff, troffcvt, unroff, troff2html, mm2html
Macro packages: man [I12.UNIXman1], me [I13.me], mm Macro packages: man [I13.UNIXman1], me [I14.me], mm
[I14.DWBguide], ms [I15.ms], mv [I14.DWBguide], rfc [I15.DWBguide], ms [I16.ms], mv [I15.DWBguide], rfc
[I2.Lilly05] [I2.Lilly05]
Additional information: Additional information:
Magic number(s): None, however the content format is distinctive Magic number(s): None, however the content format is distinctive
(see Published specification). (see Published specification).
File extension(s): Files do not require any specific "extension". File extension(s): Files do not require any specific "extension".
Many are in use as a convenience for mechanized processing of Many are in use as a convenience for mechanized processing of
files, some associated with specific macro packages or files, some associated with specific macro packages or
skipping to change at page 8, line 19 skipping to change at page 8, line 15
the nature of the content. In particular, while a file name or the nature of the content. In particular, while a file name or
a component of a name may be useful in some types of automated a component of a name may be useful in some types of automated
processing of files, the name or component might not be capable processing of files, the name or component might not be capable
of indicating subtleties such as proportion of textual (as of indicating subtleties such as proportion of textual (as
opposed to image or formatting directive) content. This media opposed to image or formatting directive) content. This media
type SHOULD NOT be assigned a relationship with any file type SHOULD NOT be assigned a relationship with any file
"extension" where content may be untrusted unless there is "extension" where content may be untrusted unless there is
provision for human judgment which may be used to override that provision for human judgment which may be used to override that
relationship for individual files. Where appropriate, a relationship for individual files. Where appropriate, a
filename MAY be suggested by a suitable mechanism such as the filename MAY be suggested by a suitable mechanism such as the
one specified in [I16.RFC2183] as amended by [N5.RFC2231] and one specified in [I17.RFC2183] as amended by [N5.RFC2231] and
[N6.Errata]. [N6.Errata].
Macintosh File Type Code(s): unknown Macintosh File Type Code(s): unknown
Person & email address to contact for further information: Person & email address to contact for further information:
Bruce Lilly Bruce Lilly
blilly@erols.com blilly@erols.com
Intended usage: COMMON Intended usage: COMMON
skipping to change at page 8, line 47 skipping to change at page 8, line 43
contained within the media content. contained within the media content.
5. Acknowledgments 5. Acknowledgments
The author would like to acknowledge the helpful comments provided by The author would like to acknowledge the helpful comments provided by
members of the ietf-types mailing list. members of the ietf-types mailing list.
6. Security Considerations 6. Security Considerations
Security considerations are discussed in the media registration. Security considerations are discussed in the media registration.
Additional considerations may apply in some contexts (e.g. MIME Additional considerations may apply when the media subtype is used in
[I17.RFC2049]). some contexts (e.g. MIME [I18.RFC2049]).
7. Internationalization Considerations 7. Internationalization Considerations
The optional charset parameter may be used to indicate the charset of The optional charset parameter may be used to indicate the charset of
the media type content. In some cases, that content's charset might the media type content. In some cases, that content's charset might
be carried through processing for display of text. In other cases, be carried through processing for display of text. In other cases,
combinations of octets in particular sequences are used to represent combinations of octets in particular sequences are used to represent
glyphs which cannot be directly represented in the content charset. glyphs which cannot be directly represented in the content charset.
In either of those categories, the language(s) of the text might not In either of those categories, the language(s) of the text might not
be evident from the character content, and it is RECOMMENDED that a be evident from the character content, and it is RECOMMENDED that a
suitable mechanism (e.g. [I18.RFC3282]) be used to convey text suitable mechanism (e.g. [I19.RFC3282]) be used to convey text
language where such a mechanism is available [I19.BCP18]. Where language where such a mechanism is available [I20.BCP18]. Where
multiple languages are used within a single document, it may be multiple languages are used within a single document, it may be
necessary or desirable to indicate the languages to readers directly necessary or desirable to indicate the languages to readers directly
via explicit indication of language in the content. In still other via explicit indication of language in the content. In still other
cases, the media type content (while readable and comprehensible in cases, the media type content (while readable and comprehensible in
text form) represents symbolic or graphical information such as text form) represents symbolic or graphical information such as
mathematical equations or chemical formulae, which are largely global mathematical equations or chemical formulae, which are largely global
and language-independent. and language-independent.
8. IANA Considerations 8. IANA Considerations
skipping to change at page 11, line 40 skipping to change at page 11, line 40
text. text.
Comments regarding the silliness, lack of accuracy, and lack of Comments regarding the silliness, lack of accuracy, and lack of
precision of the boilerplate text should be directed to the IESG, not precision of the boilerplate text should be directed to the IESG, not
to the author. to the author.
Appendix C. Change History Appendix C. Change History
[[This change history will not be part of a published RFC]] [[This change history will not be part of a published RFC]]
-03 to -04 (IESG review and RFC preparation)
o Clarified application lists as examples, not exhaustive
o Added informative reference to RFC 2048 (BCP 13) (N.B. successor
in process)
o Added clarification of extra security considerations
o Conformed draft reference to style suggested in I-D Checklist
o Revised text regarding command-line security issues
-02 to -03 (Last Call comments and final tweaks) -02 to -03 (Last Call comments and final tweaks)
o revised description of process parameter o revised description of process parameter
o cleaned up presentation of examples o cleaned up presentation of examples
o noted that RFC 2183 is amended by RFC 2231 and errata o noted that RFC 2183 is amended by RFC 2231 and errata
o updated reference to using-troff draft o updated reference to using-troff draft
o added disclaimer of boilerplate content silliness, etc. o added disclaimer of boilerplate content silliness, etc.
o added discussion of graphic overlays to security considerations o added discussion of graphic overlays to security considerations
-01 to -02 -01 to -02
skipping to change at page 13, line 6 skipping to change at page 13, line 18
[N6.Errata] RFC-Editor errata page, [N6.Errata] RFC-Editor errata page,
http://www.rfc-editor.org/errata.html http://www.rfc-editor.org/errata.html
Informative References Informative References
[I1.RFC2223] Postel, J. and J. Reynolds, "Instructions to RFC [I1.RFC2223] Postel, J. and J. Reynolds, "Instructions to RFC
Authors", RFC 2223, October 1997. Authors", RFC 2223, October 1997.
[I2.Lilly05] Lilly, B., "Writing Internet-Drafts and Requests For [I2.Lilly05] Lilly, B., "Writing Internet-Drafts and Requests For
Comments using troff and nroff", Work in progress, Comments using troff and nroff"
(April 2005). (draft-lilly-using-troff-04.txt),
(draft-lilly-using-troff-04.ps),
(draft-lilly-using-troff-04.pdf), May 2005.
[I3.RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO [I3.BCP13] Freed, N., Klensin, J., and J. Postel, "Multipurpose
Internet Mail Extensions (MIME) Part Four:
Registration Procedures", BCP 13, RFC 2048, November
1996.
[I4.RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003. 10646", STD 63, RFC 3629, November 2003.
[I4.RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., [I5.RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, Masinter, L., Leach, P., and T. Berners-Lee,
"Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616,
June 1999. June 1999.
[I5.RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of [I6.RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of
ISO 10646", RFC 2781, February 2000. ISO 10646", RFC 2781, February 2000.
[I6.CSTR49] Lesk, M. E., "TBL - A Program for Setting Tables", [I7.CSTR49] Lesk, M. E., "TBL - A Program for Setting Tables",
Bell Laboratories Computing Science Technical Report Bell Laboratories Computing Science Technical Report
#49, Murray Hill, New Jersey, 1976. #49, Murray Hill, New Jersey, 1976.
[I7.CSTR114] Bentley, Jon L. and Kernighan, Brian W., "Grap - A [I8.CSTR114] Bentley, Jon L. and Kernighan, Brian W., "Grap - A
Language for Typesetting Graphs Tutorial and User Language for Typesetting Graphs Tutorial and User
Manual", Computing Science Technical Report No.114, Manual", Computing Science Technical Report No.114,
AT&T Bell Laboratories, Murray Hill, New Jersey, 1991. AT&T Bell Laboratories, Murray Hill, New Jersey, 1991.
[I8.CSTR116] Kernighan, Brian W., "Pic - A Graphics Language for [I9.CSTR116] Kernighan, Brian W., "Pic - A Graphics Language for
Typesetting User Manual", Computing Science Technical Typesetting User Manual", Computing Science Technical
Report No.116, AT&T Bell Laboratories, Murray Hill, Report No.116, AT&T Bell Laboratories, Murray Hill,
New Jersey, 1991. New Jersey, 1991.
[I9.CSTR122] Bentley, Jon L., Jelinski, Lynn W., and Kernighan, [I10.CSTR122] Bentley, Jon L., Jelinski, Lynn W., and Kernighan,
Brian W., "Chem - A Program for Typesetting Chemical Brian W., "Chem - A Program for Typesetting Chemical
Diagrams: User Manual", Computing Science Technical Diagrams: User Manual", Computing Science Technical
Report No.122, AT&T Bell Laboratories, Murray Hill, Report No.122, AT&T Bell Laboratories, Murray Hill,
New Jersey, 1992. New Jersey, 1992.
[I10.eqn] Kernighan, Brian W, and Cherry, Lorinda L., "A System [I11.eqn] Kernighan, Brian W, and Cherry, Lorinda L., "A System
for Typesetting Mathematics", Communications of the for Typesetting Mathematics", Communications of the
ACM 18, 182-193, 1975. ACM 18, 182-193, 1975.
[I11.CSTR142] Bentley, Jon L. "DFORMAT - A Program for Typesetting [I12.CSTR142] Bentley, Jon L. "DFORMAT - A Program for Typesetting
Data Formats", Computing Science Technical Report Data Formats", Computing Science Technical Report
No.142, AT&T Bell Laboratories, Murray Hill, New No.142, AT&T Bell Laboratories, Murray Hill, New
Jersey, 1988. Jersey, 1988.
[I12.UNIXman1] AT&T Bell Laboratories, "UNIX TIME-SHARING SYSTEM [I13.UNIXman1] AT&T Bell Laboratories, "UNIX TIME-SHARING SYSTEM
(VOLUME 1) : UNIX Programmer's Manual", Holt, (VOLUME 1) : UNIX Programmer's Manual", Holt,
Rinehart, & Winston, 1979 Rinehart, & Winston, 1979
[I13.me] Allman, Eric P., "Writing Papers With NROFF Using [I14.me] Allman, Eric P., "Writing Papers With NROFF Using
-me", USD:19, University of California, Berkeley, -me", USD:19, University of California, Berkeley,
Berkeley, California, 1997. Berkeley, California, 1997.
[I14.DWBguide] AT&T Bell Laboratories, "Unix System V Documenter's [I15.DWBguide] AT&T Bell Laboratories, "Unix System V Documenter's
Workbench User's Guide", Prentice Hall, 1989 Workbench User's Guide", Prentice Hall, 1989
[I15.ms] Lesk, M. E., "Typing Documents on the UNIX System: [I16.ms] Lesk, M. E., "Typing Documents on the UNIX System:
Using the -ms Macros with Troff and Nroff", 1978, in Using the -ms Macros with Troff and Nroff", 1978, in
"UNIX TIME-SHARING SYSTEM (VOLUME 2) : UNIX "UNIX TIME-SHARING SYSTEM (VOLUME 2) : UNIX
Programmer's Manual", Holt, Rinehart, & Winston, 1979 Programmer's Manual", Holt, Rinehart, & Winston, 1979
[I16.RFC2183] Troost, R., Dorner, S., and K. Moore, "Communicating [I17.RFC2183] Troost, R., Dorner, S., and K. Moore, "Communicating
Presentation Information in Internet Messages: The Presentation Information in Internet Messages: The
Content-Disposition Header Field", RFC 2183, August Content-Disposition Header Field", RFC 2183, August
1997. 1997.
[I17.RFC2049] Freed, N. and N. Borenstein, "Multipurpose Internet [I18.RFC2049] Freed, N. and N. Borenstein, "Multipurpose Internet
Mail Extensions (MIME) Part Five: Conformance Criteria Mail Extensions (MIME) Part Five: Conformance Criteria
and Examples", RFC 2049, November 1996. and Examples", RFC 2049, November 1996.
[I18.RFC3282] Alvestrand, H., "Content Language Headers", RFC 3282, [I19.RFC3282] Alvestrand, H., "Content Language Headers", RFC 3282,
May 2002. May 2002.
[I19.BCP18] Alvestrand, H., "IETF Policy on Character Sets and [I20.BCP18] Alvestrand, H., "IETF Policy on Character Sets and
Languages", BCP 18, RFC 2277, January 1998. Languages", BCP 18, RFC 2277, January 1998.
Author's Address Author's Address
Bruce Lilly Bruce Lilly
Email: blilly@erols.com Email: blilly@erols.com
Full Copyright Statement Full Copyright Statement
 End of changes. 33 change blocks. 
44 lines changed or deleted 67 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/