manual/ucd-snmp/original/man1/snmpconf.1

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