~ubuntu-branches/ubuntu/vivid/logrotate/vivid : revision 13

4

General fixes to manpages.

5

6

7

Index: logrotate-3.7.7/logrotate.8

7

Index: logrotate-3.7.8/logrotate.8

8

===================================================================

9

--- logrotate-3.7.7.orig/logrotate.8 2008-11-07 01:43:10.299554148 +0000

10

+++ logrotate-3.7.7/logrotate.8 2008-11-07 01:43:42.559554897 +0000

11

@@ -2,7 +2,8 @@

12

.SH NAME

13

logrotate \- rotates, compresses, and mails system logs

14

.SH SYNOPSIS

15

-\fBlogrotate\fR [-dv] [-f|--force] [-s|--state \fIfile\fR] \fIconfig_file\fR+

16

+\fBlogrotate\fR [\fB\-dv\fR] [\fB\-f\fR|\fB\-\-force\fR]

17

+[\fB\-s\fR|\fB-\-state\ \fIstatefile\fR] \fIconfig_file\fR ..

18

.SH DESCRIPTION

19

\fBlogrotate\fR is designed to ease administration of systems that generate

20

large numbers of log files. It allows automatic rotation, compression,

21

@@ -10,16 +11,16 @@

9

--- logrotate-3.7.8.orig/logrotate.8 2009-02-19 13:02:12.673937406 +0000

10

+++ logrotate-3.7.8/logrotate.8 2009-02-19 13:03:32.070280105 +0000

11

@@ -11,9 +11,9 @@

22

12

weekly, monthly, or when it grows too large.

23

13

.P

24

14

Normally, \fBlogrotate\fR is run as a daily cron job. It will not modify

27

17

-each day, or unless the \fB-f\fR or \fB-force\fR option is used.

28

18

+a log more than once in one day unless the criterion for that log is

29

19

+based on the log's size and \fBlogrotate\fR is being run more than once

30

+each day, or unless the \fB-f\fR or \fB-\-force\fR option is used.

20

+each day, or unless the \fB-f\fR or \fB-force\fR option is used.

31

21

.P

32

22

Any number of config files may be given on the command line. Later config

33

23

files may override the options given in earlier files, so the order

34

-in which the \fBlogrotate\fR config files are listed in is important.

35

+in which the \fBlogrotate\fR config files are listed is important.

36

Normally, a single config file which includes any other config files

37

which are needed should be used. See below for more information on how

38

-to use the \fIinclude\fR directive to accomplish this. If a directory

39

+to use the \fBinclude\fR directive to accomplish this. If a directory

40

is given on the command line, every file in that directory is used as

41

a config file.

42

.P

43

@@ -35,33 +36,35 @@

44

be made to the logs or to the \fBlogrotate\fR state file.

45

46

.TP

47

-\fB-f, -\-force\fR

48

+\fB-f\fR, \fB-\-force\fR

49

Tells \fBlogrotate\fR to force the rotation, even if it doesn't think

50

this is necessary. Sometimes this is useful after adding new entries to

51

-\fBlogrotate\fR, or if old log files have been removed by hand, as the

52

-new files will be created, and logging will continue correctly.

53

+a \fBlogrotate\fR config file, or if old log files have been removed

54

+by hand, as the new files will be created, and logging will continue

55

+correctly.

56

+

57

58

.TP

59

-\fB-m, -\-mail <command>\fR

60

+\fB-m\fR, \fB-\-mail <command>\fR

24

@@ -48,14 +48,14 @@

61

25

Tells \fBlogrotate\fR which command to use when mailing logs. This

62

26

command should accept two arguments: 1) the subject of the message, and

63

27

2) the recipient. The command must then read a message on standard input

75

39

76

40

.TP

77

41

\fB-\-usage\fR

78

Prints a short usage message.

42

@@ -63,7 +63,7 @@

79

43

80

44

.TP

81

-\fB-v\fR

45

\fB-v\fR, \fB-\-verbose\fR

82

46

-Turns on verbose mode.

83

+\fB-v\fR, \fB--verbose\fR

84

+Display messages during rotation.

47

+Turns on verbose mode, ie. display messages during rotation.

85

48

86

49

.SH CONFIGURATION FILE

87

50

88

@@ -80,7 +83,7 @@

89

rotate 5

90

weekly

91

postrotate

92

- /sbin/killall -HUP syslogd

93

+ /sbin/killall -HUP syslogd

94

endscript

95

}

96

97

@@ -90,7 +93,7 @@

98

size=100k

99

sharedscripts

100

postrotate

101

- /sbin/killall -HUP httpd

102

+ /sbin/killall -HUP httpd

103

endscript

104

}

105

106

@@ -100,7 +103,7 @@

107

olddir /var/log/news/old

108

missingok

109

postrotate

110

- kill -HUP `cat /var/run/inn.pid`

111

+ kill -HUP `cat /var/run/inn.pid`

112

endscript

113

nocompress

114

}

115

@@ -110,9 +113,9 @@

51

@@ -112,9 +112,9 @@

116

52

The first few lines set global options; in the example, logs are

117

53

compressed after they are rotated. Note that comments may appear

118

54

anywhere in the config file as long as the first non-whitespace

124

60

\fI/var/log/messages\fR. The log will go through five weekly rotations before

125

61

being removed. After the log file has been rotated (but before the old

126

62

version of the log has been compressed), the command

127

@@ -120,14 +123,15 @@

63

@@ -122,14 +122,15 @@

128

64

129

65

The next section defines the parameters for both

130

66

\fI/var/log/httpd/access.log\fR and \fI/var/log/httpd/error.log\fR.

145

81

146

82

The last section defines the parameters for all of the files in

147

83

\fI/var/log/news\fR. Each file is rotated on a monthly basis. This is

148

@@ -138,29 +142,33 @@

84

@@ -140,6 +141,10 @@

149

85

rotate all files, including previously rotated ones. A way around this

150

86

is to use the \fBolddir\fR directive or a more exact wildcard (such as *.log).

151

87

156

92

Here is more information on the directives which may be included in

157

93

a \fBlogrotate\fR configuration file:

158

94

159

.TP

160

\fBcompress\fR

161

-Old versions of log files are compressed with \fBgzip\fR by default. See also

162

-\fBnocompress\fR.

163

+Old versions of log files are compressed with \fBgzip\fR(1) by default.

164

+See also \fBnocompress\fR.

165

95

@@ -151,12 +156,12 @@

166

96

.TP

167

97

\fBcompresscmd\fR

168

98

Specifies which command to use to compress log files. The default is

177

107

178

108

.TP

179

109

\fBcompressext\fR

180

Specifies which extension to use on compressed logfiles, if compression

181

-is enabled. The default follows that of the configured compression

182

-command.

183

+is enabled. The default follows that of the default compression

184

+command (.gz).

185

186

.TP

187

\fBcompressoptions\fR

188

@@ -177,7 +185,7 @@

110

@@ -179,7 +184,7 @@

189

111

190

112

.TP

191

113

\fBcopytruncate\fR

194

116

instead of moving the old log file and optionally creating a new one.

195

117

It can be used when some program cannot be told to close its logfile

196

118

and thus might continue writing (appending) to the previous log file forever.

197

@@ -191,7 +199,7 @@

198

Immediately after rotation (before the \fBpostrotate\fR script is run)

199

the log file is created (with the same name as the log file just rotated).

200

\fImode\fR specifies the mode for the log file in octal (the same

201

-as \fBchmod(2)\fR), \fIowner\fR specifies the user name who will own the

202

+as \fBchmod\fR(2)), \fIowner\fR specifies the user name who will own the

203

log file, and \fIgroup\fR specifies the group the log file will belong

204

to. Any of the log file attributes may be omitted, in which case those

205

attributes for the new file will use the same values as the original log

206

@@ -217,21 +225,21 @@

207

.TP

208

\fBdelaycompress\fR

209

Postpone compression of the previous log file to the next rotation cycle.

210

-This has only effect when used in combination with \fBcompress\fR.

211

+This only has effect when used in combination with \fBcompress\fR.

212

It can be used when some program cannot be told to close its logfile

213

and thus might continue writing to the previous log file for some time.

214

119

@@ -228,7 +233,7 @@

215

120

.TP

216

121

\fBextension \fIext\fR

217

122

Log files with \fIext\fR extension can keep it after the rotation.

220

125

appears after \fIext\fR. For example you have a logfile named mylog.foo

221

126

and want to rotate it to mylog.1.foo.gz instead of mylog.foo.1.gz.

222

127

223

.TP

224

\fBifempty\fR

225

Rotate the log file even if it is empty, overriding the \fBnotifempty\fR

226

-option (ifempty is the default).

227

+option (\fBifempty\fR is the default).

228

229

.TP

230

\fBinclude \fIfile_or_directory\fR

231

@@ -242,12 +250,12 @@

232

which are ignored are files which are not regular files (such as

233

directories and named pipes) and files whose names end with one of

234

the taboo extensions, as specified by the \fBtabooext\fR directive.

235

-The \fBinclude\fR directive may not appear inside of a log file

236

+The \fBinclude\fR directive may not appear inside a log file

237

definition.

128

@@ -251,7 +256,7 @@

238

129

239

130

.TP

240

131

\fBmail \fIaddress\fR

243

134

no mail should be generated by a particular log, the \fBnomail\fR directive

244

135

may be used.

245

136

246

@@ -289,8 +297,7 @@

247

248

.TP

249

\fBnocompress\fR

250

-Old versions of log files are not compressed with \fBgzip\fR. See also

251

-\fBcompress\fR.

252

+Old versions of log files are not compressed. See also \fBcompress\fR.

253

254

.TP

255

\fBnocopy\fR

256

@@ -318,7 +325,7 @@

137

@@ -321,7 +326,7 @@

257

138

258

139

.TP

259

140

\fBnomail\fR

262

143

263

144

.TP

264

145

\fBnomissingok\fR

265

@@ -326,7 +333,7 @@

146

@@ -329,7 +334,7 @@

266

147

267

148

.TP

268

149

\fBnoolddir\fR

271

152

overrides the \fBolddir\fR option).

272

153

273

154

.TP

274

@@ -357,8 +364,8 @@

275

\fBpostrotate\fR/\fBendscript\fR

276

The lines between \fBpostrotate\fR and \fBendscript\fR (both of which

277

must appear on lines by themselves) are executed after the log file is

278

-rotated. These directives may only appear inside of a log file definition.

279

-See \fBprerotate\fR as well. See \fBsharedscripts\fR and

280

+rotated. These directives may only appear inside a log file definition.

281

+See also \fBprerotate\fR. See \fBsharedscripts\fR and

282

\fBnosharedscripts\fR for error handling.

283

284

.TP

285

@@ -366,8 +373,8 @@

286

The lines between \fBprerotate\fR and \fBendscript\fR (both of which

287

must appear on lines by themselves) are executed before the log file is

288

rotated and only if the log will actually be rotated. These directives

289

-may only appear inside of a log file definition. See \fBpostrotate\fR

290

-as well. See \fBsharedscripts\fR and \fBnosharedscripts\fR for error

291

+may only appear inside a log file definition. See also \fBpostrotate\fR.

292

+See \fBsharedscripts\fR and \fBnosharedscripts\fR for error

293

handling.

294

295

.TP

296

@@ -385,13 +392,13 @@

297

must appear on lines by themselves) are executed once after all log

298

files that match the wildcarded pattern are rotated, after postrotate script

299

is run and only if at least one log is rotated. These directives may only

300

-appear inside of a log file definition. If the script exits with

301

+appear inside a log file definition. If the script exits with

302

error, just an error message is shown (as this is the last

303

-action). See \fBfirstaction\fR as well.

304

+action). See also \fBfirstaction\fR.

305

306

.TP

307

\fBrotate \fIcount\fR

308

-Log files are rotated <count> times before being removed or mailed to the

309

+Log files are rotated \fIcount\fR times before being removed or mailed to the

310

address specified in a \fBmail\fR directive. If \fIcount\fR is 0, old versions

311

are removed rather than rotated.

312

313

@@ -399,15 +406,16 @@

314

\fBsize \fIsize\fR

315

Log files are rotated when they grow bigger than \fIsize\fR bytes. If

316

\fIsize\fR is followed by \fIM\fR, the size if assumed to be in megabytes.

317

+If the \fIG\fR suffix is used, the size is in gigabytes.

318

If the \fIk\fR is used, the size is in kilobytes. So \fBsize 100\fR,

319

\fIsize 100k\fR, and \fIsize 100M\fR are all valid.

155

@@ -403,7 +408,7 @@

156

\fIsize\fR is followed by \fIk\fR, the size is assumed to be in kilobytes.

157

If the \fIM\fR is used, the size is in megabytes, and if \fIG\fR is used, the

158

size is in gigabytes. So \fBsize 100\fR, \fIsize 100k\fR, \fIsize 100M\fR and

159

-\fIsize 100G\f are all valid.

160

+\fIsize 100G\fR are all valid.

320

161

321

162

.TP

322

163

\fBsharedscripts\fR

323

-Normally, \fBprescript\fR and \fBpostscript\fR scripts are run for each

324

+Normally, \fBprerotate\fR and \fBpostrotate\fR scripts are run for each

325

log which is rotated, meaning that a single script may be run multiple

326

times for log file entries which match multiple files (such as the

327

-/var/log/news/* example). If \fBsharedscript\fR is specified, the scripts

328

+\fI/var/log/news/*\fR example). If \fBsharedscript\fR is specified, the scripts

329

are only run once, no matter how many logs match the wildcarded pattern.

330

However, if none of the logs in the pattern require rotating, the scripts

331

will not be run at all. If the scripts exit with error, the remaining

332

@@ -439,15 +447,16 @@

164

@@ -442,15 +447,16 @@

333

165

for information on the taboo extensions). If a + precedes the list of

334

166

extensions, the current taboo extension list is augmented, otherwise it

335

167

is replaced. At startup, the taboo extension list

349

181

350

182

.TP

351

183

\fByearly\fR

352

@@ -463,11 +472,16 @@

353

Configuration options.

354

184

@@ -468,9 +474,14 @@

355

185

.SH SEE ALSO

356

-.IR gzip (1)

357

+.BR gzip (1)

358

+

186

.BR gzip (1)

187

359

188

+.SH NOTES

360

189

+The \fBkillall\fR(1) program in Debian is found in the \fIpsmisc\fR package.

361

190

+

362

191

.SH AUTHORS

363

192

.nf

364

193

Erik Troan <ewt@redhat.com>