Back to index

natlog  0.91.0
usage.cc
Go to the documentation of this file.
00001 //                     usage.cc
00002 
00003 #include "main.ih"
00004 
00005 void usage(std::string const &progname)
00006 {
00007     cout << "\n" <<
00008     progname << " by " << Icmbuild::author << "\n" <<
00009     progname << " V" << Icmbuild::version << " " << Icmbuild::years << "\n"
00010     "\n"
00011     "Usage: " << progname << " [options] command\n"
00012     "Where:\n"
00013     "   [options] - optional arguments (short options between parentheses):\n"
00014     "      --config (-c) path - path: pathname of the configuation file\n"
00015     "                           (default: `" << 
00016                                 Options::defaultConfigPath() << "')\n"
00017     "      --conntrack-path path - path: path to the `conntrack' program\n"
00018     "                           (default `" << 
00019                                 Options::defaultConntrackPath() << "')\n"
00020     "      --help (-h)        - provide this help\n"
00021     "      --no-daemon        - do not run " << progname << 
00022                                                         " in the background\n"
00023     "      --no-syslog        - do not write syslog messages\n"
00024     "      --pid-file (-p) path - `path' is the name of the file holding "
00025                                                                     "the\n"
00026     "                           daemon's PID (default `\n" <<
00027                                 Options::defaultPIDfile() << "')\n"
00028     "      --syslog-tag id  - id: identifier prefixed to syslog messages\n"
00029     "                           (default `" << 
00030                                 Options::defaultSyslogIdent() << "')\n"
00031     "      --syslog-facility fac  - fac: syslog facility to use\n"
00032     "                           (default `" << 
00033                                 Options::defaultSyslogFacility() << "')\n"
00034     "      --syslog-priority pri  - pri: syslog priority to use\n"
00035     "                           (default `" << 
00036                                 Options::defaultSyslogPriority() << "')\n"
00037     "      --stdout (-s)      - write syslog-equivalent messages to the std "
00038                                                                 "output\n"
00039     "                            (implied by --verbose; only for " 
00040                                                             "--no-daemon)\n"
00041     "      --time (-t) spec   - time specification:\n"
00042     "                            raw: (default) seconds since the epoch;\n"
00043     "                            utc: date and time in UTC\n"
00044     "                            local: local date and time\n"
00045     "      --verbose          - write additional information:\n"
00046     "                               with --no-daemon: to stdout;\n"
00047     "                               with daemons and --no-syslog not "
00048                                                                 "specified:\n"
00049     "                                                 to the syslog daemon\n"
00050     "                            (only for --no-daemon)\n"
00051     "      --version (-v)     - show version information and terminate\n"
00052     "      --warn (-w)        - warn about not-registered connections\n"
00053     "                            (suppressed by --no-daemon)\n"
00054     "   command   - command to execute:\n"
00055     "       conntrack:  use `conntrack' to find the source-nat connections\n"
00056     "       in out:     in, out: names of network devices (e.g., eth0)\n"
00057     "                   directly capture packets on the `in' and `out' "
00058                                                                 "devices\n"
00059     "                   in: soource natting is applied to its source "
00060                                                                 "addresses\n"
00061     "                   out: the device connecting to the destination\n"
00062     "                        addresses\n"
00063 
00064 
00065     "\n";
00066 }