Print this page
5051 import mdocml-1.12.3
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Approved by: TBD
   1 .\" Copryight 2014 Garrett D'Amore <garrett@damore.org>
   2 .\" Copyright (c) 1995, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .Dd "Jul 19, 2014"
   7 .Dt MAN 5
   8 .Os
   9 .Sh NAME
  10 .Nm man
  11 .Nd macros to format Reference Manual pages
  12 .Sh SYNOPSIS
  13 .Nm mandoc
  14 .Fl T Ar man
  15 .Ar
  16 .Nm nroff
  17 .Fl man
  18 .Ar
  19 .Nm troff
  20 .Fl man
  21 .Ar
  22 .Sh DESCRIPTION
  23 These macros are used to lay out the reference pages in this manual. Note: if
  24 .Ar file
  25 contains format input for a preprocessor, the commands shown
  26 above must be piped through the appropriate preprocessor. This is handled


 218 with the command or function.
 219 .El
 220 .Sh FILES
 221 .Pa /usr/share/man/whatis
 222 .Sh NOTES
 223 The
 224 .Nm
 225 package should not be used for new documentation.  The
 226 .Xr mdoc 5 ,
 227 package is preferred, as it uses semantic markup rather than physical markup.
 228 .Sh CODE SET INDEPENDENCE
 229 When processed with
 230 .Xr mandoc 1 ,
 231 this package is Code Set Independent. However, when processed with
 232 legacy tools such as
 233 .Xr nroff 1
 234 and
 235 .Xr troff 1 ,
 236 the use of multi-byte characters may not be supported.
 237 .Sh INTERFACE STABILITY
 238 .Nm Obsolete Committed .
 239 The
 240 .Xr mdoc 5
 241 package should be used instead.
 242 .Sh SEE ALSO
 243 .Xr eqn 1 ,
 244 .Xr man 1 ,
 245 .Xr mandoc 1 ,
 246 .Xr nroff 1 ,
 247 .Xr troff 1 ,
 248 .Xr tbl 1 ,
 249 .Xr whatis 1 ,
 250 .Xr mdoc 5 ,
 251 .Rs
 252 .%A Dale Dougherty and Tim O'Reilly
 253 .%B Unix Text Processing
 254 .Re
   1 .\" Copryight 2014 Garrett D'Amore <garrett@damore.org>
   2 .\" Copyright (c) 1995, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .Dd "Jul 30, 2014"
   7 .Dt MAN 5
   8 .Os
   9 .Sh NAME
  10 .Nm man
  11 .Nd macros to format Reference Manual pages
  12 .Sh SYNOPSIS
  13 .Nm mandoc
  14 .Fl T Ar man
  15 .Ar
  16 .Nm nroff
  17 .Fl man
  18 .Ar
  19 .Nm troff
  20 .Fl man
  21 .Ar
  22 .Sh DESCRIPTION
  23 These macros are used to lay out the reference pages in this manual. Note: if
  24 .Ar file
  25 contains format input for a preprocessor, the commands shown
  26 above must be piped through the appropriate preprocessor. This is handled


 218 with the command or function.
 219 .El
 220 .Sh FILES
 221 .Pa /usr/share/man/whatis
 222 .Sh NOTES
 223 The
 224 .Nm
 225 package should not be used for new documentation.  The
 226 .Xr mdoc 5 ,
 227 package is preferred, as it uses semantic markup rather than physical markup.
 228 .Sh CODE SET INDEPENDENCE
 229 When processed with
 230 .Xr mandoc 1 ,
 231 this package is Code Set Independent. However, when processed with
 232 legacy tools such as
 233 .Xr nroff 1
 234 and
 235 .Xr troff 1 ,
 236 the use of multi-byte characters may not be supported.
 237 .Sh INTERFACE STABILITY
 238 .Sy Obsolete Committed .
 239 The
 240 .Xr mdoc 5
 241 package should be used instead.
 242 .Sh SEE ALSO
 243 .Xr eqn 1 ,
 244 .Xr man 1 ,
 245 .Xr mandoc 1 ,
 246 .Xr nroff 1 ,
 247 .Xr troff 1 ,
 248 .Xr tbl 1 ,
 249 .Xr whatis 1 ,
 250 .Xr mdoc 5 ,
 251 .Rs
 252 .%A Dale Dougherty and Tim O'Reilly
 253 .%B Unix Text Processing
 254 .Re