← Back to branch summary

~jeff-apple/openvista-gtm-integration/bug368789

« back to all changes in this revision

Viewing changes to docs/man1/ovpurgejournals.1

  • Committer: Jonathan Tai
  • Date: 2009-04-20 17:00:01 UTC
  • mfrom: (21.1.6 bug326435)
  • Revision ID: jon.tai@medsphere.com-20090420170001-gr4z4wg24b7crnf0
Merge bug 326435 - Linux commands should come with man pages

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man1/ovpurgejournals.1
 
1
.TH ovpurgejournals 1 "18 Apr 2009" Linux "User Manuals"
 
2
.SH NAME
 
3
ovpurgejournals \- delete old journal files
 
4
.SH SYNOPSIS
 
5
.B ovpurgejournals [-h]
 
6
.I instance_name
 
7
.SH DESCRIPTION
 
8
.B ovpurgejournals
 
9
deletes old journal files beyond the configured number of journal files to
 
10
keep.  The number of old journal files to keep can be configured on a
 
11
per-instance basis in the 
 
12
.I etc/journals.conf
 
13
file in the instance's root directory.
 
14
.PP
 
15
By default, the
 
16
.I /etc/cron.daily/openvista
 
17
cron job runs
 
18
.B ovpurgejournals
 
19
on each OpenVista instance once each day.  An OpenVista instance can "opt-out"
 
20
by setting purge_daily to "no" in the 
 
21
.I etc/journals.conf
 
22
file in the instance's root directory.  Journals can be set to run on a custom
 
23
schedule by adding an entry to the 
 
24
.I /etc/cron.d/openvista
 
25
file.
 
26
.PP
 
27
Root privileges are not required to run
 
28
.B ovpurgejournals
 
29
\- anyone who can access the OpenVista instance can delete journals.
 
30
.PP
 
31
.SH OPTIONS
 
32
.IP -h
 
33
display help text
 
34
.SH FILES
 
35
.I /opt/openvista/INSTANCE_NAME/etc/journals.conf
 
36
.RS
 
37
Specifies how many old journals to keep in the 
 
38
.I journals
 
39
directory.
 
40
.SH "REPORTING BUGS"
 
41
Please report any bugs you encounter at
 
42
.PP
 
43
https://bugs.launchpad.net/openvista-gtm-integration
 
44
.SH AUTHOR
 
45
Jonathan Tai <jon.tai@medsphere.com>
 
46
.SH "SEE ALSO"
 
47
.BR ovbackup (1)