Blame doc/mrtg-contrib.1

Packit 667938
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
Packit 667938
.\"
Packit 667938
.\" Standard preamble:
Packit 667938
.\" ========================================================================
Packit 667938
.de Sp \" Vertical space (when we can't use .PP)
Packit 667938
.if t .sp .5v
Packit 667938
.if n .sp
Packit 667938
..
Packit 667938
.de Vb \" Begin verbatim text
Packit 667938
.ft CW
Packit 667938
.nf
Packit 667938
.ne \\$1
Packit 667938
..
Packit 667938
.de Ve \" End verbatim text
Packit 667938
.ft R
Packit 667938
.fi
Packit 667938
..
Packit 667938
.\" Set up some character translations and predefined strings.  \*(-- will
Packit 667938
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
Packit 667938
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
Packit 667938
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
Packit 667938
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
Packit 667938
.\" nothing in troff, for use with C<>.
Packit 667938
.tr \(*W-
Packit 667938
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
Packit 667938
.ie n \{\
Packit 667938
.    ds -- \(*W-
Packit 667938
.    ds PI pi
Packit 667938
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
Packit 667938
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
Packit 667938
.    ds L" ""
Packit 667938
.    ds R" ""
Packit 667938
.    ds C` ""
Packit 667938
.    ds C' ""
Packit 667938
'br\}
Packit 667938
.el\{\
Packit 667938
.    ds -- \|\(em\|
Packit 667938
.    ds PI \(*p
Packit 667938
.    ds L" ``
Packit 667938
.    ds R" ''
Packit 667938
.    ds C`
Packit 667938
.    ds C'
Packit 667938
'br\}
Packit 667938
.\"
Packit 667938
.\" Escape single quotes in literal strings from groff's Unicode transform.
Packit 667938
.ie \n(.g .ds Aq \(aq
Packit 667938
.el       .ds Aq '
Packit 667938
.\"
Packit 667938
.\" If the F register is turned on, we'll generate index entries on stderr for
Packit 667938
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
Packit 667938
.\" entries marked with X<> in POD.  Of course, you'll have to process the
Packit 667938
.\" output yourself in some meaningful fashion.
Packit 667938
.\"
Packit 667938
.\" Avoid warning from groff about undefined register 'F'.
Packit 667938
.de IX
Packit 667938
..
Packit 667938
.nr rF 0
Packit 667938
.if \n(.g .if rF .nr rF 1
Packit 667938
.if (\n(rF:(\n(.g==0)) \{
Packit 667938
.    if \nF \{
Packit 667938
.        de IX
Packit 667938
.        tm Index:\\$1\t\\n%\t"\\$2"
Packit 667938
..
Packit 667938
.        if !\nF==2 \{
Packit 667938
.            nr % 0
Packit 667938
.            nr F 2
Packit 667938
.        \}
Packit 667938
.    \}
Packit 667938
.\}
Packit 667938
.rr rF
Packit 667938
.\"
Packit 667938
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Packit 667938
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
Packit 667938
.    \" fudge factors for nroff and troff
Packit 667938
.if n \{\
Packit 667938
.    ds #H 0
Packit 667938
.    ds #V .8m
Packit 667938
.    ds #F .3m
Packit 667938
.    ds #[ \f1
Packit 667938
.    ds #] \fP
Packit 667938
.\}
Packit 667938
.if t \{\
Packit 667938
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
Packit 667938
.    ds #V .6m
Packit 667938
.    ds #F 0
Packit 667938
.    ds #[ \&
Packit 667938
.    ds #] \&
Packit 667938
.\}
Packit 667938
.    \" simple accents for nroff and troff
Packit 667938
.if n \{\
Packit 667938
.    ds ' \&
Packit 667938
.    ds ` \&
Packit 667938
.    ds ^ \&
Packit 667938
.    ds , \&
Packit 667938
.    ds ~ ~
Packit 667938
.    ds /
Packit 667938
.\}
Packit 667938
.if t \{\
Packit 667938
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
Packit 667938
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
Packit 667938
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
Packit 667938
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
Packit 667938
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
Packit 667938
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
Packit 667938
.\}
Packit 667938
.    \" troff and (daisy-wheel) nroff accents
Packit 667938
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
Packit 667938
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
Packit 667938
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
Packit 667938
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
Packit 667938
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
Packit 667938
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
Packit 667938
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
Packit 667938
.ds ae a\h'-(\w'a'u*4/10)'e
Packit 667938
.ds Ae A\h'-(\w'A'u*4/10)'E
Packit 667938
.    \" corrections for vroff
Packit 667938
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
Packit 667938
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
Packit 667938
.    \" for low resolution devices (crt and lpr)
Packit 667938
.if \n(.H>23 .if \n(.V>19 \
Packit 667938
\{\
Packit 667938
.    ds : e
Packit 667938
.    ds 8 ss
Packit 667938
.    ds o a
Packit 667938
.    ds d- d\h'-1'\(ga
Packit 667938
.    ds D- D\h'-1'\(hy
Packit 667938
.    ds th \o'bp'
Packit 667938
.    ds Th \o'LP'
Packit 667938
.    ds ae ae
Packit 667938
.    ds Ae AE
Packit 667938
.\}
Packit 667938
.rm #[ #] #H #V #F C
Packit 667938
.\" ========================================================================
Packit 667938
.\"
Packit 667938
.IX Title "MRTG-CONTRIB 1"
Packit 667938
.TH MRTG-CONTRIB 1 "2018-07-13" "2.17.7" "mrtg"
Packit 667938
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
Packit 667938
.\" way too many mistakes in technical documents.
Packit 667938
.if n .ad l
Packit 667938
.nh
Packit 667938
.SH "NAME"
Packit 667938
mrtg\-contrib \- Contribution Guidelines for MRTG
Packit 667938
.SH "DESCRIPTION"
Packit 667938
.IX Header "DESCRIPTION"
Packit 667938
If you have written an extension to mrtg or created a bug fix, please
Packit 667938
consider contributing it to the project. As I get quite a number of
Packit 667938
contributions every week, here are a few guidelines which explain how to
Packit 667938
contribute so that I can use the contribution without too much additional
Packit 667938
work.
Packit 667938
.SS "Translations"
Packit 667938
.IX Subsection "Translations"
Packit 667938
\&\s-1MRTG\s0 messages have been translated to a number of languages but there are
Packit 667938
still many which have not been covered yet. If you want to add yours, go
Packit 667938
into the \fImrtg\-2.17.7/translate\fR directory and follow the instructions
Packit 667938
given in the \fI\s-1README\s0\fR file.
Packit 667938
.SS "Patches"
Packit 667938
.IX Subsection "Patches"
Packit 667938
When you have created your modification or extension to mrtg and want to
Packit 667938
submit it to me, please crate a patch for the files which you have modified.
Packit 667938
Do not send entire files unless they are new.
Packit 667938
.PP
Packit 667938
To create a patch, get hold of a copy of \s-1GNU\s0 diff (Many Unix systems will
Packit 667938
have this installed already. In the \s-1NT\s0 world you might want to get
Packit 667938
http://sources.redhat.com/cygwin/ to get all the nice \s-1GNU\s0 tools available.)
Packit 667938
and type
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& diff \-\-unified \-\-ignore\-space\-change old\-file new\-file > simple.patch
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
or if you have modified several files do
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& diff \-\-recursive \-\-unified \-\-ignore\-space\-change old\-dir/ new\-dir/ >long.patch
Packit 667938
.Ve
Packit 667938
.SS "Documentation"
Packit 667938
.IX Subsection "Documentation"
Packit 667938
All documentation of mrtg is done with the perl \fB\s-1POD\s0\fR system. If you want to
Packit 667938
learn about it, type
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& perldoc perlpod
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
and read the instructions. If you have bugfixes or additions to the existing
Packit 667938
documents, make sure you modify the \fB\s-1POD\s0\fR files and not the html or txt
Packit 667938
versions.
Packit 667938
.PP
Packit 667938
I take documentation very seriously. Whenever you create a new feature for
Packit 667938
mrtg which you want to get included in the official release, your patch must
Packit 667938
also contain modifications for the relevant \fBpod\fR file in the \fIdoc\fR tree or
Packit 667938
for the documentation sections of \fIcfgmaker\fR and \fIindexmaker\fR.
Packit 667938
.SH "ADDRESS"
Packit 667938
.IX Header "ADDRESS"
Packit 667938
Send your patches, translations and contributions to Tobias Oetiker
Packit 667938
<tobi@oetiker.ch>
Packit 667938
.SH "AUTHOR"
Packit 667938
.IX Header "AUTHOR"
Packit 667938
Tobias Oetiker <tobi@oetiker.ch>