/contrib/groff/src/roff/nroff/nroff.man

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 153 lines · 148 code · 5 blank · 0 comment · 0 complexity · d7964d439956dff3fbc45968f9ff9b16 MD5 · raw file

  1. .ig
  2. Copyright (C) 1989-2001, 2002, 2003, 2005 Free Software Foundation, Inc.
  3. Permission is granted to make and distribute verbatim copies of
  4. this manual provided the copyright notice and this permission notice
  5. are preserved on all copies.
  6. Permission is granted to copy and distribute modified versions of this
  7. manual under the conditions for verbatim copying, provided that the
  8. entire resulting derived work is distributed under the terms of a
  9. permission notice identical to this one.
  10. Permission is granted to copy and distribute translations of this
  11. manual into another language, under the above conditions for modified
  12. versions, except that this permission notice may be included in
  13. translations approved by the Free Software Foundation instead of in
  14. the original English.
  15. $FreeBSD$
  16. ..
  17. .
  18. .TH @G@NROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  19. .
  20. .SH NAME
  21. @g@nroff \- emulate nroff command with groff
  22. .
  23. .SH SYNOPSIS
  24. .nr a \n(.j
  25. .ad l
  26. .nr i \n(.i
  27. .in +\w'\fB@g@nroff 'u
  28. .ti \niu
  29. .B @g@nroff
  30. .de OP
  31. .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
  32. .el .RB "[\ " "\\$1" "\ ]"
  33. ..
  34. .
  35. .OP \-CchipStUv
  36. .OP \-d cs
  37. .OP \-M dir
  38. .OP \-m name
  39. .OP \-n num
  40. .OP \-o list
  41. .OP \-r cn
  42. .OP \-T name
  43. .RI "[\ " "file" "\ .\|.\|.\ ]"
  44. .br
  45. .ad \na
  46. .
  47. .SH DESCRIPTION
  48. The
  49. .B @g@nroff
  50. script emulates the
  51. .B nroff
  52. command using groff.
  53. Only
  54. .BR ascii ,
  55. .BR latin1 ,
  56. .BR koi8-r ,
  57. .BR utf8 ,
  58. and
  59. .B cp1047
  60. are valid arguments for the
  61. .B -T
  62. option, selecting the output encoding emitted by
  63. .BR grotty ,
  64. groff's TTY output device.
  65. If an invalid or no
  66. .BR \-T
  67. option is given,
  68. .B @g@nroff
  69. checks the current locale to select a default output device.
  70. It first tries the
  71. .B locale
  72. program, then the environment variables
  73. .BR LC_ALL ,
  74. .BR LC_CTYPE ,
  75. and
  76. .BR LANG ,
  77. and finally the
  78. .B LESSCHARSET
  79. environment variable.
  80. .PP
  81. The
  82. .B \-h
  83. and
  84. .B \-c
  85. options
  86. are equivalent to
  87. .BR grotty 's
  88. options
  89. .B \-h
  90. (using tabs in the output) and
  91. .B \-c
  92. (using the old output scheme instead of SGR escape sequences).
  93. The
  94. .BR \-d ,
  95. .BR \-C ,
  96. .BR \-i ,
  97. .BR \-M ,
  98. .BR \-m ,
  99. .BR \-n ,
  100. .BR \-o ,
  101. and
  102. .B \-r
  103. options have the effect described in
  104. .BR @g@troff (@MAN1EXT@).
  105. In addition,
  106. .B @g@nroff
  107. silently ignores the options
  108. .BR \-e ,
  109. .BR \-q ,
  110. and
  111. .BR \-s
  112. (which are not implemented in
  113. .BR @g@troff ).
  114. Options
  115. .B \-p
  116. (pic),
  117. .B \-t
  118. (tbl),
  119. .B \-S
  120. (safer), and
  121. .B \-U
  122. (unsafe) are passed to
  123. .BR groff .
  124. .B \-v
  125. shows the version number.
  126. .
  127. .SH ENVIRONMENT
  128. .TP
  129. .SM
  130. .B GROFF_BIN_PATH
  131. A colon separated list of directories in which to search for the
  132. .B groff
  133. executable before searching in PATH. If unset, `@BINDIR@' is used.
  134. .SH NOTES
  135. This shell script is basically intended for use with
  136. .BR man (1),
  137. so warnings are suppressed.
  138. nroff-style character definitions (in the file tty-char.tmac) are also
  139. loaded to emulate unrepresentable glyphs.
  140. .
  141. .SH "SEE ALSO"
  142. .BR groff (@MAN1EXT@),
  143. .BR @g@troff (@MAN1EXT@),
  144. .BR grotty (@MAN1EXT@)
  145. .
  146. .\" Local Variables:
  147. .\" mode: nroff
  148. .\" End: