← Back to branch summary

~ubuntu-branches/ubuntu/raring/maradns/raring

« back to all changes in this revision

Viewing changes to debian/patches/duende_man.patch

  • Committer: Bazaar Package Importer
  • Author(s): Nicholas Bamber
  • Date: 2011-07-18 12:57:54 UTC
  • mfrom: (10.1.9 sid)
  • Revision ID: james.westby@ubuntu.com-20110718125754-7x4bp0qvs8q60s4n
Tags: 1.4.06-3
http://bugs.debian.org/484466
http://bugs.debian.org/582069
* Made duende more generic and Debian compatible
  - Added patch to use argp to parse arguments
  - Added support for --pid, --uid, --chroot, --ident, --restart_on,
    and --gid arguments
  - Put log helper process in chroot
  - Write pid of log helper process to syslog
  - Consolidated waitpid calls so to avoid race condition allowing zombies
  - Adjusted section and priority, cf. #632337
  - Added example to show how to use duende generically
  - Added patch to man page documenting changes to duende
* Rewrote maradns init script to use new duende features
  - Init script now relatively standard apart from use of duende and 
    support for multiple servers
  - Reload action in maradns script now sends signal to duende which
    restarts maradns process (Closes: #484466)
  - Added Recommends clause for maradns-zoneserver
* Added comment about #621833 in postrm script and ensured complete removal
  of /etc/maradns directory
* Added maradns-zoneserver package (Closes: #582069)
  - Note that the reload action is not supported for zoneserver
* Updated python support
* Updated TODO.Debian

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/patches/duende_man.patch
 
1
Author: Nicholas Bamber <nicholas@periapt.co.uk>
 
2
Subject: Duende man page
 
3
 We have made various changes to the duende executable and these need to
 
4
 be reflected in the Debian man page.
 
5
Forwarded: yes
 
6
Last-Update: 2011-07-18
 
7
--- a/doc/en/man/duende.8
 
8
+++ b/doc/en/man/duende.8
 
9
@@ -29,11 +29,12 @@
 
10
 makes a given child process a daemon. The standard output
 
11
 and standard error
 
12
 of the child process is logged via syslog() with a priority of
 
13
-LOG_INFO.
 
14
+LOG_ALERT.
 
15
 .SH "USAGE"
 
16
 .PP
 
17
 .B "duende"
 
18
-child_process [ all subsequent arguments passed on to child ]
 
19
+.RB [ options ]
 
20
+child_process [ arguments passed onto child ]
 
21
 .SH "DETAILS"
 
22
 .PP
 
23
 When
 
24
@@ -76,48 +77,52 @@
 
25
 duende uses a setuid() call to change the user ID of the logging
 
26
 process
 
27
 to the user with ID 66.
 
28
+.SH "OPTIONS"
 
29
+.PP
 
30
+Most of the above behaviour can be configured by command line arguments.
 
31
+.TP 4
 
32
+.BI -c | --chroot " directory"
 
33
+The log helper process will change its directory and root to this location.
 
34
+This defaults to
 
35
+.B /etc/maradns/logger "."
 
36
+.TP 4
 
37
+.BI -i | --ident " string"
 
38
+The log helper process will use this string to identify the process when
 
39
+sending messages to syslog.
 
40
+This defaults to
 
41
+.B log-help "."
 
42
+.TP 4
 
43
+.BI -p | --pid " filename"
 
44
+If this argument is present, the duende parent process will store its pid in
 
45
+this file.
 
46
+.TP 4
 
47
+.BI -u | --uid " integer"
 
48
+The log helper process will drop its user id to this. This value defaults to
 
49
+66.
 
50
+.TP 4
 
51
+.BI -g | --gid " integer"
 
52
+The log helper process will drop its group id to this. This value defaults to
 
53
+66.
 
54
+.TP 4
 
55
+.BI -r | --restart_on " integer"
 
56
+The log helper process will restart the child process if it exists with this
 
57
+status code. This defaults to 8.
 
58
 .SH "LOGGING"
 
59
 .PP
 
60
 .B "duende"
 
61
 uses the syslog() facility to log the standard output of the
 
62
 program that it invokes. The name of the program (in other words, the
 
63
-"ident" given to openlog()) is the full path of the first argument
 
64
-given
 
65
-to
 
66
-.BR "duende" "."
 
67
+"ident" given to openlog()) defaults to
 
68
+.BR "log-helper"
 
69
+but can be overridden with the
 
70
+.RB "--ident"
 
71
+argument.
 
72
 All messages created by the child process are sent
 
73
-to syslog() with a priority of LOG_INFO and a "facility"
 
74
-of LOG_DAEMON (daemon.info in /etc/syslog.conf); since daemon.info
 
75
-messages are not logged by default in FreeBSD, on FreeBSD systems
 
76
-messages generated by the child process are logged with a priority of
 
77
-LOG_ALERT and a "facility" of LOG_DAEMON (daemon.alert in
 
78
-/etc/syslog.conf).
 
79
+to syslog() with a priority of LOG_ALERT and a "facility"
 
80
+of LOG_DAEMON (daemon.info in /etc/syslog.conf).
 
81
 Should duende itself encounter an error, it will send
 
82
 messages to syslog() with a priority of LOG_ALERT.
 
83
 .PP
 
84
-For example, suppose one invokes duende thusly:
 
85
-
 
86
-.nf
 
87
-       duende /usr/local/sbin/maradns
 
88
-.fi
 
89
-
 
90
-If invoked thusly, duende will log all messages with the "ident"
 
91
-(program
 
92
-name) of "/usr/local/sbin/maradns". If this is not desired, invoke
 
93
-duende
 
94
-with something like:
 
95
-
 
96
-.nf
 
97
-       export PATH=$PATH:/usr/local/sbin
 
98
-       duende maradns
 
99
-.fi
 
100
-
 
101
-This will log messages with a (more sensible) "ident" of maradns.
 
102
-.PP
 
103
-Note: If a non-POSIX Bourne shell (such as csh, es, rc, or fish) is
 
104
-used to
 
105
-invoke MaraDNS, the above syntax needs to be changed.
 
106
-.PP
 
107
 Also, the directory /etc/maradns/logger, while used by duende, is not
 
108
 used
 
109
 to store any log messages. That is unless, for some reason, one