Provided by: sigit_0.3.2-2ubuntu1_amd64 bug

NAME

       sigit.rc - configuration file for sigit.

DESCRIPTION

       The program sigit uses a sigit.rc file placed in the /etc dir, or if the user has made his
       own .sigitrc file in his $HOME dir, it will read from that. With this file, the outcome of
       the program can be costumised.

       Any lines starting with a # will be regarded as a comment, and therefor there will be
       taken no action to the line. Since this program is inteded to be monitoring several
       signatures, then each setting will be started with the line: fifo{ and once the matching }
       is reached, it will be considdered as the settings for one of the signatures beeing
       monitored.

       Should you want to have a small comment telling, exactly why you used the setting, then
       adding a '# comment here' further onto the line, will result in any leeding spaces and
       anything comming after the '#' sign beeing deleted from the setting ie:

       name=John Bon Jovi     # I'm assuming people knows him..

       Will in the program be used as "name=John Bon Jovi", so if you are planing to keep the
       intended spaces after the last _non_ TAB or space char, you shouldn't put a # in the line.
       Bare in mind this is only used during reading of the <ident>=<setting> sections, so if you
       use # in the pretty setting there should be no problems.

OPTIONS

       The sigit.rc file or .sigitrc file handles the options mentioned below, if there are other
       settings beeing used, which isn't mentioned here, it will omit them.

       <fifo_file>
            This is the signature file which will be written from the program. You set this
            option starting from your $HOME. If it's not set, it will default write to your
            $HOME/.signature file.

       <data_file>
            This is the data file which the program reads the signatures from. This is a binary
            file, since it gives the fastest and easiest way of searching through the file for
            the desired signature to use.  If this setting starts with a / it is assumed it is
            taken specified from root, else the setting should be specified from $HOME. If its
            not set, it will default use /usr/local/share/sigit/sigit.data. (Or set to sigit.data
            located in the directory specified by ./configure --prefix during compilation)

       <debug_file>
            Sine this new version of the program is intended to run in threads, then you'll need
            some other form of debugging, since the stderr or stdout isn't enough, it would
            simply be too confusing, therefor every fifo can be assigned a special debug_file
            setting. If it isn't set, the request for debug, will be discarted.

       <debug>
            This is the setting to determain, if there should be any debug info written to the
            preset debug_file setting, if this is set to 'yes' then it will be performed, if not,
            then the specified debug_file won't even be touched.

       <limit_sig>
            If you want to limit the signatures shown for some of your mails, then use this flag.
            It is to be used as:

            limit_sig=signatureID1-signatureID2

            where the signatures found between signatureID1 and signatureID2 will be selected at
            random, if you only want one signature shown, then use it with only signatureID1 and
            leave out the -signatureID2.

            Remember the signatureID can be found, by doing a sigitdb --list on the signature
            data file.

       <top_line>
            This is the setting for the top line in your signature. Most people use this as a
            info on their real e-mail address, or their name. If this in the end will be more
            than 72 chars, then the rest of the line will be discarted, so it's only the first 72
            chars thats used.  However you can use any of the conversion chars to display system
            info, as described in the pretty setting.

       <bottom_line>
            This is the setting for the bottom line in your signature, normaly you would use this
            as an info on where your regular homepage might be located. Same requirement goes for
            this line, as for the top-line.

       <boxes_config>
            This is a quite uniq setting. This should point to the placement of your boxes
            configuration file. (Usualy /usr/share/boxes) If it is set, Sigit will select a
            random box from the configuration file, no matter if you've already set the '-d' flag
            in the boxes_flags Should this setting not start with a '/' it will assume you are
            giving the filename from $HOME.

       <boxes_flags>
            This is the flags you would usualy use, when invoking boxes to produce the box around
            your signatures, this could be -dpeek or any other of the flags, if several are
            needed, then just put them on the line, as:

            boxes_flags=-ahlvt -k1 -dpeek

            One thing that is quite importain, in these flags it is not acceptable to include any
            redirect of the output, to some file or in any way change the output from boxes, like
            using -l, -h, -v or any other that wont result in the signature beeing boxed.

       <boxing>
            If you accept to use boxes, in creating the signature. This setting will take either
            true/false or yes/no, and if it is set to false (or no) there will be no box created
            around the signature, no matter which flags the <boxes_flags> is holding.

       <email>
            If you would like your name displayed in the signature, but won't use the pretty
            setting to conform your own, you can let sigit fill it in, with its magnificient
            email signing. When using this, I'm not sure if the bottom_line setting should be
            used at all, I personaly think you need to experiment with it, befor the combination
            of these settings look right.

       <name>
            This has the same effect as the email setting.

       <show_ident>
            If you would like to have a Kool signature like:

            Statement 0x0E12CFF:
               The Linux philosophy is:
                 "Laugh in the face of danger"  -Oops wrong one..
                 "Do it your self"  -Thats it.

            Then the show_ident must be set to 'yes' or 'true', The program will use the
            signature number assigned in the db-file as the numbering of the statement.

            If you want another explanation than the ''dull'' Statement, then just fill in the
            wanted explanation as the argument to show_ident

       <spam_catcher>
            Since I tend to get _alot_ of spam from time to time, I've added this neat flag to
            the setting. If you provide any name or email setting, and this is set to yes or
            true, there will be a ''<rchong@fcc.gov>, <rhundt@fcc.gov>, <uce@ftc.gov>,
            <sness@fcc.gov>,<president@whitehouse.gov>,
            <haesslich@loyalty.org>,<jquello@fcc.gov>'' line added to the signature.

       <dash>
            This is a setting I put in, since some mail programs will automatic place a "-- \n"
            right befor the actual signature. Some news readers/servers removes the part of the
            message located belov this dilimiter to save space. If your mail program dosn't
            provide this feature, and you would like to follow the standard, then set it to yes,
            else set it to no.

       <nfs_delay>
            If the fifo mentioned in this section is located on a NFS mounted environment, or
            you're using pine with a fifo, then there will be some problems reading from a fifo.
            This setting will be the seconds you think is a good delay between checking for any
            changes in the NFS equiped fifo checking. If set at anything less or equal to 0, the
            NFS support will be disabled. Should you have set this to 'yes', the default setting
            of 15 seconds will be used.

            The use of this NFS setting can also bennefit users, whos mail system can't read from
            a dedicated fifo, this way the fifo will appear as a regular raw text file, and thus
            any mail client should be able to read from it, so it eliminates the ksigit program.

       <pretty>
            If you have a few desired lines, you like to put infront of the signature, then you
            should place it in the pretty section. The program will read every line located in
            this section, and keep them as the leading pieces of the lines used in the resulting
            signature. There are a few pre defined things to these lines, if you need to have a %
            in it, you use '%%', because the '%' is a conversion char. The following special
            chars are available.

            %C   Displayes the internal call-name of the Sigit version, ie: CVS-$Date: 2003/07/28
                 17:44:38 $

            %H   Displayes the homepage for the program.

            %L   Displayes the current load in a format like: 0.01 0.10 0.13 (This will only work
                 on a system with /proc/loadavg) giving info on system load averages for the past
                 1, 5, and 15 minutes.

            %M   Displayes the machine architechture, ie: i586/i686/Alpha/Risc

            %N   Displayes the node name, ie: machine.domain.com

            %P   Displayes the program name.

            %R   Displayes the kernel version.

            %S   Displayes the System name, ie: Linux/HP-UX/OSF1/OpenBSD/FreeBSD

            %T   Gives the current time of the system in a format lik: hh:mm

            %U   Displayes the current uptime in a format like: hh:mm up Xdays  hours:minuts
                 (This will only work on a system with /proc/uptime)

            %V   Displayes the current version of the program.

       If your using pine, then it's not an error in the program, if you get a "-- \n" above your
       signature eventho, you specificaly told it not to put one. Pine reads the signature, then
       if it reads a "-- \n" as the first line, it won't put a delimiter on its own, if it wasn't
       the special delimiter it found, it will put one automatic. So when using pine theres
       nothing to do to avoid the delimiter.

EXAMPLES

       A valid .sigitrc file could look something like this:

       ยท    @Sigit@

            fifo{
              fifo_file=.signature
              data_file=.signature-data
              debug_file=.signature-debug
              debug=yes
              top_line=------------[ %P-%V. ]-----
              bottom_line=------------[ %H ]--
              email=kn@redhead.dk
              name=Kenneh 'Redhead' nielsen
              show_ident=yes
              dash=yes
              pretty{
              }

            }

            fifo{
              fifo_file=.plan
              data_file=.plan-data
              debug_file=.plan-debug
              debug=no
              boxes_flags=-k1 -ahlvt -dpeek
              boxing=yes
              show_ident=yes
              dash=yes
              pretty{
              }

            }

SEE ALSO

       sigit(1) sigitdb(1)

License and Disclaimer

       Sigit are Copyright (c) 2000, 2001, 2002, 2003 by Kenneth 'Redhead' Nielsen. Sigit may be
       used and distributed under the terms of the GNU General Public License. All other brand
       and product names are trademarks, registered trademarks or service marks of their
       respective holders.

       These programs are distributed in the hope that it will be useful, but WITHOUT ANY
       WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
       PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this
       distribution; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite
       330, Boston, MA 02111, USA.

AUTHOR

       Sigit written by

       Kenneth 'Redhead' Nielsen <redhead@diku.dk>

       Documentation formatting by

       Kenneth 'Redhead' Nielsen <redhead@diku.dk>

       All future infos on the sigit exploration, can be found at: <http://www.redhead.dk>