/usr.bin/catman/catman.1

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 109 lines · 109 code · 0 blank · 0 comment · 0 complexity · d25957785161679641d51a975fa1981f MD5 · raw file 

    

  1. .\" Copyright (c) 2002 John Rochester
    2. 

  2. .\" All rights reserved.
    3. 

  3. .\"
    4. 

  4. .\" Redistribution and use in source and binary forms, with or without
    5. 

  5. .\" modification, are permitted provided that the following conditions
    6. 

  6. .\" are met:
    7. 

  7. .\" 1. Redistributions of source code must retain the above copyright
    8. 

  8. .\"    notice, this list of conditions and the following disclaimer.
    9. 

  9. .\" 2. Redistributions in binary form must reproduce the above copyright
    10. 

  10. .\"    notice, this list of conditions and the following disclaimer in the
    11. 

  11. .\"    documentation and/or other materials provided with the distribution.
    12. 

  12. .\"
    13. 

  13. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    14. 

  14. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    15. 

  15. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    16. 

  16. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    17. 

  17. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    18. 

  18. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    19. 

  19. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    20. 

  20. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    21. 

  21. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    22. 

  22. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    23. 

  23. .\" SUCH DAMAGE.
    24. 

  24. .\"
    25. 

  25. .\" $FreeBSD$
    26. 

  26. .\"
    27. 

  27. .Dd December 3, 2005
    28. 

  28. .Dt CATMAN 1
    29. 

  29. .Os
    30. 

  30. .Sh NAME
    31. 

  31. .Nm catman
    32. 

  32. .Nd "preformat man pages"
    33. 

  33. .Sh SYNOPSIS
    34. 

  34. .Nm
    35. 

  35. .Op Fl fLnrv
    36. 

  36. .Op Ar directories ...
    37. 

  37. .Sh DESCRIPTION
    38. 

  38. The
    39. 

  39. .Nm
    40. 

  40. utility preformats all the man pages in
    41. 

  41. .Ar directories
    42. 

  42. using the
    43. 

  43. .Nm nroff Fl man
    44. 

  44. command.
    45. 

  45. Directories may be separated by colons instead of spaces.
    46. 

  46. If no
    47. 

  47. .Ar directories
    48. 

  48. are specified, the contents of the
    49. 

  49. .Ev MANPATH
    50. 

  50. environment variable is used, or if that is not set, the default directory
    51. 

  51. .Pa /usr/share/man
    52. 

  52. is processed.
    53. 

  53. .Pp
    54. 

  54. The options are as follows:
    55. 

  55. .Bl -tag -width indent
    56. 

  56. .It Fl f
    57. 

  57. Force all man pages to be reformatted even if the corresponding cat page
    58. 

  58. is newer.
    59. 

  59. .It Fl L
    60. 

  60. Process only localized subdirectories corresponding to the locale specified
    61. 

  61. in the standard environment variables.
    62. 

  62. .It Fl n
    63. 

  63. Print out what would be done instead of performing any formatting.
    64. 

  64. .It Fl r
    65. 

  65. Scan for and remove
    66. 

  66. .Dq junk
    67. 

  67. files that are neither man pages nor their
    68. 

  68. corresponding formatted cat pages.
    69. 

  69. .It Fl v
    70. 

  70. Cause
    71. 

  71. .Nm
    72. 

  72. to be more verbose about what it is doing.
    73. 

  73. .El
    74. 

  74. .Sh ENVIRONMENT
    75. 

  75. .Bl -tag -width ".Ev MANPATH"
    76. 

  76. .It Ev LC_ALL , LC_CTYPE , LANG
    77. 

  77. These variables control what subdirectories will be processed if the
    78. 

  78. .Fl L
    79. 

  79. option is used.
    80. 

  80. .It Ev MACHINE
    81. 

  81. If set, overrides the current machine type when searching for
    82. 

  82. machine specific man page subdirectories.
    83. 

  83. .It Ev MACHINE_ARCH
    84. 

  84. If set, overrides the current architecture when searching for
    85. 

  85. architecture specific man page subdirectories.
    86. 

  86. .It Ev MANPATH
    87. 

  87. Determines the set of directories to be processed if none are given on
    88. 

  88. the command line.
    89. 

  89. .El
    90. 

  90. .Sh FILES
    91. 

  91. .Bl -tag -width ".Pa /usr/share/man" -compact
    92. 

  92. .It Pa /usr/share/man
    93. 

  93. Default directory to process if the
    94. 

  94. .Ev MANPATH
    95. 

  95. environment variable is not set.
    96. 

  96. .El
    97. 

  97. .Sh EXIT STATUS
    98. 

  98. .Ex -std
    99. 

  99. .Sh SEE ALSO
    100. 

  100. .Xr makewhatis 1 ,
    101. 

  101. .Xr man 1 ,
    102. 

  102. .Xr nroff 1
    103. 

  103. .Sh HISTORY
    104. 

  104. A previous version of the
    105. 

  105. .Nm
    106. 

  106. command appeared in
    107. 

  107. .Fx 2.1 .
    108. 

  108. .Sh AUTHORS
    109. 

  109. .An John Rochester
    110.