/contrib/bsnmp/gensnmpdef/gensnmpdef.1

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

    

  1. .\"
    2. 

  2. .\" Copyright (C) 2004-2006
    3. 

  3. .\"	Hartmut Brandt.
    4. 

  4. .\"	All rights reserved.
    5. 

  5. .\"
    6. 

  6. .\" Author: Harti Brandt <harti@FreeBSD.org>
    7. 

  7. .\" 
    8. 

  8. .\" Redistribution and use in source and binary forms, with or without
    9. 

  9. .\" modification, are permitted provided that the following conditions
    10. 

  10. .\" are met:
    11. 

  11. .\" 1. Redistributions of source code must retain the above copyright
    12. 

  12. .\"    notice, this list of conditions and the following disclaimer.
    13. 

  13. .\" 2. Redistributions in binary form must reproduce the above copyright
    14. 

  14. .\"    notice, this list of conditions and the following disclaimer in the
    15. 

  15. .\"    documentation and/or other materials provided with the distribution.
    16. 

  16. .\" 
    17. 

  17. .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    18. 

  18. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    19. 

  19. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    20. 

  20. .\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
    21. 

  21. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    22. 

  22. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    23. 

  23. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    24. 

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

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

  26. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    27. 

  27. .\" SUCH DAMAGE.
    28. 

  28. .\"
    29. 

  29. .\" $Begemot: gensnmpdef.1 383 2006-05-30 07:40:49Z brandt_h $
    30. 

  30. .\"
    31. 

  31. .Dd May 28, 2006
    32. 

  32. .Dt GENSNMPDEF 1
    33. 

  33. .Os
    34. 

  34. .Sh NAME
    35. 

  35. .Nm gensnmpdef
    36. 

  36. .Nd "generate a MIB description file from MIBs"
    37. 

  37. .Sh SYNOPSIS
    38. 

  38. .Nm
    39. 

  39. .Op Fl hEe
    40. 

  40. .Op Fl c Ar cut
    41. 

  41. .Ar name Op Ar ...
    42. 

  42. .Sh DESCRIPTION
    43. 

  43. The
    44. 

  44. .Nm
    45. 

  45. utility is used to create an initial MIB description file from
    46. 

  46. one or more MIBs.
    47. 

  47. The description file must be edited to be actually useful
    48. 

  48. for feeding it into
    49. 

  49. .Xr gensnmptree 1 .
    50. 

  50. .Pp
    51. 

  51. The following options are available:
    52. 

  52. .Bl -tag -width indent
    53. 

  53. .It Fl c Ar cut
    54. 

  54. Specify the number of initial sub-oids that should be omitted
    55. 

  55. from the tree in the output.
    56. 

  56. .Xr gensnmptree 1
    57. 

  57. automatically adds 1.3.6 in front of all OIDs so the default value
    58. 

  58. of 3 is just correct in most cases.
    59. 

  59. .It Fl E
    60. 

  60. Generate typedefs for named enumerations.
    61. 

  61. These are enumerations defined via the TEXTUAL-CONVENTION macro.
    62. 

  62. The normal tree output is suppressed.
    63. 

  63. .It Fl e
    64. 

  64. Generate typedefs for unnamed enumerations.
    65. 

  65. These are enumerations defined in the SYNTAX clause of an OBJECT-TYPE macro.
    66. 

  66. The name of the enumeration is formed by appending the string
    67. 

  67. .Ql Type
    68. 

  68. to the name of the object.
    69. 

  69. The normal tree output is suppressed.
    70. 

  70. .It Fl h
    71. 

  71. Print a short help text and exit.
    72. 

  72. .El
    73. 

  73. .Pp
    74. 

  74. .Nm
    75. 

  75. does no attempt on sorting the OID tree so in case of complex and
    76. 

  76. non-standard MIBs it is necessary to sort the tree in the resulting definition
    77. 

  77. file by hand.
    78. 

  78. .Sh SEE ALSO
    79. 

  79. .Xr snmpd 1
    80. 

  80. .Sh AUTHORS
    81. 

  81. .An Hartmut Brandt Aq harti@FreeBSD.org
    82. 

  82. .Sh BUGS
    83. 

  83. The utility is by no means bullet-proof and may fail for complex
    84. 

  84. or non-standard MIBs.
    85. 

  85. Its output is expected to be edited by hand.
    86.