1MRTG-CONTRIB(1)                      mrtg                      MRTG-CONTRIB(1)
2
3
4

NAME

6       mrtg-contrib - Contribution Guidelines for MRTG
7

DESCRIPTION

9       If you have written an extension to mrtg or created a bug fix, please
10       consider contributing it to the project. As I get quite a number of
11       contributions every week, here are a few guidelines which explain how
12       to contribute so that I can use the contribution without too much addi‐
13       tional work.
14
15       Translations
16
17       MRTG messages have been translated to a number of languages but there
18       are still many which have not been covered yet. If you want to add
19       yours, go into the mrtg-2.15.1/translate directory and follow the
20       instructions given in the README file.
21
22       Patches
23
24       When you have created your modification or extension to mrtg and want
25       to submit it to me, please crate a patch for the files which you have
26       modified.  Do not send entire files unless they are new.
27
28       To create a patch, get hold of a copy of GNU diff (Many Unix systems
29       will have this installed already. In the NT world you might want to get
30       http://sources.redhat.com/cygwin/ to get all the nice GNU tools avail‐
31       able.)  and type
32
33        diff --unified --ignore-space-change old-file new-file > simple.patch
34
35       or if you have modified several files do
36
37        diff --recursive --unified --ignore-space-change old-dir/ new-dir/ >long.patch
38
39       Documentation
40
41       All documentation of mrtg is done with the perl POD system. If you want
42       to learn about it, type
43
44        perldoc perlpod
45
46       and read the instructions. If you have bugfixes or additions to the
47       existing documents, make sure you modify the POD files and not the html
48       or txt versions.
49
50       I take documentation very seriously. Whenever you create a new feature
51       for mrtg which you want to get included in the official release, your
52       patch must also contain modifications for the relevant pod file in the
53       doc tree or for the documentation sections of cfgmaker and indexmaker.
54

ADDRESS

56       Send your patches, translations and contributions to Tobias Oetiker
57       <tobi@oetiker.ch>
58

AUTHOR

60       Tobias Oetiker <tobi@oetiker.ch>
61
62
63
642.15.1                            2007-02-01                   MRTG-CONTRIB(1)
Impressum