man/network-settings.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <refentry id="network-settings">
   6         <refentryinfo>
   7                 <title>network-settings</title>
   8                 <productname>network</productname>
   9
  10                 <authorgroup>
  11                         <author>
  12                                 <contrib>Developer</contrib>
  13                                 <firstname>Michael</firstname>
  14                                 <surname>Tremer</surname>
  15                                 <email>michael.tremer@ipfire.org</email>
  16                         </author>
  17                 </authorgroup>
  18         </refentryinfo>
  19
  20         <refmeta>
  21                 <refentrytitle>network-settings</refentrytitle>
  22                 <manvolnum>8</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26                 <refname>network-settings</refname>
  27                 <refpurpose>Network Configuration Control Program</refpurpose>
  28         </refnamediv>
  29
  30         <refsynopsisdiv>
  31                 <cmdsynopsis>
  32                         <command>network settings</command>
  33                 </cmdsynopsis>
  34
  35                 <cmdsynopsis>
  36                         <command>network settings <replaceable>KEY=VALUE</replaceable></command>
  37                 </cmdsynopsis>
  38         </refsynopsisdiv>
  39
  40         <refsect1>
  41                 <title>Description</title>
  42
  43                 <para>
  44                         The <command>network settings</command> command may be used to set
  45                         global settingsuration options.
  46                 </para>
  47                 <para>
  48                         Please have a look at the individual man pages for more options.
  49                 </para>
  50         </refsect1>
  51
  52         <refsect1>
  53                 <title>Commands</title>
  54
  55                 <para>
  56                         If no additional argument is given, running the command will
  57                         dump a list of all settingsuration variables and their current values.
  58                 </para>
  59
  60                 <para>
  61                         You may set a new value by adding the variable name and the new
  62                         value to the command line.
  63                 </para>
  64         </refsect1>
  65
  66         <refsect1>
  67                 <title>Variables</title>
  68
  69                 <variablelist>
  70                         <varlistentry>
  71                                 <term>
  72                                         <varname>COLORS</varname>=[<emphasis>auto</emphasis>|on|off]
  73                                 </term>
  74
  75                                 <listitem>
  76                                         <para>
  77                                                 This will control the output of the console tools.
  78                                                 <varname>on</varname> will enable colorful output all
  79                                                 the time, <varname>off</varname> will disable colors.
  80                                         </para>
  81                                         <para>
  82                                                 The default setting is <varname>auto</varname> which will
  83                                                 automatically detect if the console supports colors.
  84                                         </para>
  85                                         <para>
  86                                                 Colorful output is very helpful to spot important information
  87                                                 more quickly.
  88                                         </para>
  89                                 </listitem>
  90                         </varlistentry>
  91
  92                         <varlistentry>
  93                                 <term>
  94                                         <varname>DEBUG</varname>=[<emphasis>0</emphasis>|1]
  95                                 </term>
  96
  97                                 <listitem>
  98                                         <para>
  99                                                 The <varname>DEBUG</varname> will control whether debug
 100                                                 logging is enabled or not. Additionally to writing debug
 101                                                 log messages to the log files, the messages will be displayed
 102                                                 on the console as well.
 103                                         </para>
 104                                 </listitem>
 105                         </varlistentry>
 106                 </variablelist>
 107         </refsect1>
 108
 109         <refsect1>
 110                 <title>See Also</title>
 111
 112                 <para>
 113                         <citerefentry>
 114                                 <refentrytitle>network</refentrytitle>
 115                                 <manvolnum>8</manvolnum>
 116                         </citerefentry>,
 117                         <citerefentry>
 118                                 <refentrytitle>network-dns-server</refentrytitle>
 119                                 <manvolnum>8</manvolnum>
 120                         </citerefentry>
 121                 </para>
 122         </refsect1>
 123 </refentry>