svn-mailer(1)

1SVN-MAILER(1)                    User Commands                   SVN-MAILER(1)
2
3
4

NAME

6       svn-mailer - A feature rich subversion commit notification tool
7

SYNOPSIS

9       svn-mailer --commit -d repos -r rev [-f config]
10
11       svn-mailer --propchange -d repos -r rev -a author -n propname
12           [-o action] [-f config]
13
14       svn-mailer --lock -d repos -a author [-f config]
15
16       svn-mailer --unlock -d repos -a author [-f config]
17

DESCRIPTION

19       The  svnmailer  package  is  a tool to post notifications of subversion
20       events to various targets in different  ways.   Currently  implemented:
21       Mail  via  SMTP  or a sendmail pipe, news via NNTP, XML via XMLRPC to a
22       CIA tracker (see http://cia.navi.cx/ for details).
23
24       The svn-mailer command line script is  typically  invoked  via  subver‐
25       sion's  hook  mechanism,  but you can run it manually as well.  This is
26       useful to resend missing messages or for debugging purposes.   Remember
27       to  start  it  under  the correct user/group id.  Otherwise it may have
28       problems to open the repository or the config file.
29
30       The svnmailer can be used in most cases as a  drop-in  replacement  for
31       mailer.py  distributed  with subversion.  There are some subtle differ‐
32       ences which are dedicated to more  behavior  consistency.   (Hopefully)
33       all of them are stated in the HTML documentation.
34
35   GENERAL OPTIONS
36       --version
37              show program's version number and exit
38
39       -h, --help
40              show a help message and exit
41
42   COMMON PARAMETERS
43       --debug
44              Run in debug mode (means basically that all messages are sent to
45              STDOUT)
46
47       -dREPOSITORY, --repository=REPOSITORY
48              The repository directory
49
50       -fCONFIG, --config=CONFIG
51              The configuration file
52
53       -ePATH_ENCODING, --path-encoding=PATH_ENCODING
54              Specifies the character encoding to be used  for  filenames.  By
55              default  the  encoding  is  tried to be determined automatically
56              depending on the locale.
57
58   BEHAVIOR OPTIONS
59       The behavior options are mutually exclusive, i.e. the last one wins.
60
61       -c, --commit
62              This is a regular commit of versioned data  (post-commit  hook).
63              This is default.
64
65       -p, --propchange
66              This  is a modification of unversioned properties (post-revprop-
67              change hook)
68
69       -l, --lock
70              (svn 1.2 and later) This is a locking call (post-lock hook). The
71              locked file names are read from STDIN.
72
73       -u, --unlock
74              (svn 1.2 and later) This is a unlocking call (post-unlock hook).
75              The unlocked file names are read from STDIN.
76
77   SUPPLEMENTAL PARAMETERS
78       -rREVISION, --revision=REVISION
79              The modified/committed revision number
80
81       -aAUTHOR, --author=AUTHOR
82              The author of the modification
83
84       -nPROPNAME, --propname=PROPNAME
85              The name of the modified property
86
87       -oACTION, --action=ACTION
88              (svn 1.2 and later) The property change  action.  If  specified,
89              the old property value is read from STDIN.
90

CONFIGURATION FILES

92       If  the  configuration  file is not specified on the command line it is
93       searched at default locations. The first one found is loaded. The loca‐
94       tions are, in order: svnmailer.conf in the conf/ directory of the given
95       repository, svnmailer.conf in the script  directory  itself,  /etc/svn‐
96       mailer.conf.
97

OLD STYLE COMMAND LINE

99       Alternatively  you  can  use  the old style compatibility command lines
100       (options described above don't apply then):
101
102       svn-mailer commit repos rev [config]
103
104       svn-mailer propchange repos rev author propname [config]
105
106       With svn 1.2 and later:
107       svn-mailer propchange2 repos rev author propname action [config]
108
109       svn-mailer lock repos author [config]
110
111       svn-mailer unlock repos author [config]
112

REPORTING BUGS

114       If you've found a bug or have an idea how  to  improve  the  svnmailer,
115       please send a mail to <svnmailer-bugs@perlig.de>.
116

AUTHOR INFORMATION

118       André "nd" Malo <nd@perlig.de>, GPG: 0x8103A37E
119