release/src/router/snmp/man/snmpconf.1.def

   1 .TH SNMPCONF 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
   2 .UC 4
   3 .SH NAME
   4 snmpconf - creates and modifies SNMP configuration files
   5 .SH SYNOPSIS
   6 .B snmpconf
   7 [OPTIONS] [fileToCreate]
   8 .IP "Start with:"
   9 .B snmpconf
  10 -g basic_setup
  11 .IP "Or even just:"
  12 .B snmpconf
  13 .SH DESCRIPTION
  14 .B snmpconf
  15 is a simple Perl script that walks you through setting up a
  16 configuration file step by step.  It should be fairly straight forward
  17 to use.  Merely run it and answer its questions.
  18 .PP
  19 In its default mode of operation, it prompts the user with menus
  20 showing sections of the various configuration files it knows about.
  21 When the user selects a section, a sub-menu is shown listing of the
  22 descriptions of the tokens that can be created in that section.  When
  23 a description is selected, the user is prompted with questions that
  24 construct the configuration line in question.
  25 .PP
  26 Finally, when the user quits the program any configuration files that
  27 have been edited by the user are saved to the local directory, fully
  28 commented.
  29 .PP
  30 A particularly useful option is the
  31 .B -g
  32 switch, which walks a user through a specific set of configuration
  33 questions.  Run:
  34 .RS
  35 .PP
  36 snmpconf -g basic_setup
  37 .RE
  38 .PP
  39 for an example.
  40 .SH "OPTIONS"
  41 .TP 8
  42 .B -f
  43 Force overwriting existing files in the current directory without
  44 prompting the user if this is a desired thing to do.
  45 .TP
  46 .B -i
  47 When finished, install the files into the location where the global
  48 system commands expect to find them.
  49 .TP
  50 .B -p
  51 When finished, install the files into the users home directory's .snmp
  52 subdirectory (where the applications will also search for
  53 configuration files).
  54 .TP
  55 .BI -I " DIRECTORY"
  56 When finished, install the files into the directory
  57 .IR DIRECTORY .
  58 .TP
  59 .B -a
  60 Don't ask any questions.  Simply read in the various known
  61 configuration files and write them back out again.  This has the
  62 effect of "auto-commenting" the configuration files for you.  See
  63 the
  64 .B NEAT TRICKS
  65 section below.
  66 .TP
  67 .BI -r all|none
  68 Read in either all or none of the found configuration files.  Normally
  69 .B snmpconf
  70 prompts you for which files you wish to read in.  Reading in
  71 these configuration files will merge these files with the results of
  72 the questions that it asks of you.
  73 .TP
  74 .BI -R " FILE,..."
  75 Read in a specific list of configuration files.
  76 .TP
  77 .BI -g " GROUPNAME"
  78 Groups of configuration entries can be created that can be used to
  79 walk a user through a series of questions to create an initial
  80 configuration file.  There are no menus to navigate, just a list of
  81 questions.  Run:
  82 .RS
  83 .RS
  84 .PP
  85 snmpconf -g basic_setup
  86 .RE
  87 .PP
  88 for a good example.
  89 .RE
  90 .TP
  91 .B -G
  92 List all the known groups.
  93 .TP
  94 .BI -c " CONFIGDIR"
  95 .B snmpconf
  96 uses a directory of configuration information to learn about
  97 the files and questions that it should be asking.  This option tells
  98 .B snmpconf
  99 to use a different location for configuring itself.
 100 .TP
 101 .B -q
 102 Run slightly more quietly.  Since this is an interactive program, I
 103 don't recommend this option since it only removes information from the
 104 output that is designed to help you.
 105 .TP
 106 .B -d
 107 Turn on
 108 .B lots
 109 of debugging output.
 110 .TP
 111 .B -D
 112 Add
 113 .B even more
 114 debugging output in the form of Perl variable dumps.
 115 .IP
 116 .SH "NEAT TRICKS"
 117 .IP "snmpconf -g basic_setup"
 118 Have I mentioned this command enough yet?  It's designed to walk
 119 someone through an initial setup for the
 120 .I snmpd(8)
 121 daemon.  Really, you should try it.
 122 .IP "snmpconf -R /usr/local/snmp/snmpd.conf -a -f snmpd.conf"
 123 Automatically reads in an snmpd.conf file (for example) and adds
 124 comments to them describing what each token does.  Try it.  It's cool.
 125 .SH "NOTES"
 126 .B snmpconf
 127 is actually a very generic utility that could be easily
 128 configured to help construct just about any kind of configuration
 129 file.  Its default configuration set of files are SNMP based.
 130 .SH SEE ALSO
 131 snmpd(8), snmp_config(5), snmp.conf(5), snmpd.conf(5)