← Back to branch summary

~ubuntu-branches/ubuntu/maverick/rrdtool/maverick

« back to all changes in this revision

Viewing changes to doc/rrdflushcached.1

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2010-07-22 08:07:01 UTC
  • mfrom: (1.2.8 upstream) (3.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100722080701-k46mgdfz6euxwqsm
Tags: 1.4.3-1ubuntu1
* Merge from debian unstable, Remaining changes:
  - debian/control: Don't build against ruby1.9 as we don't want
    it in main.
* require libdbi >= 0.8.3 to prevent aborts when using dbi datasources

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rrdflushcached.1
 
1
.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
 
2
.\"
 
3
.\" Standard preamble:
 
4
.\" ========================================================================
 
5
.de Sp \" Vertical space (when we can't use .PP)
 
6
.if t .sp .5v
 
7
.if n .sp
 
8
..
 
9
.de Vb \" Begin verbatim text
 
10
.ft CW
 
11
.nf
 
12
.ne \\$1
 
13
..
 
14
.de Ve \" End verbatim text
 
15
.ft R
 
16
.fi
 
17
..
 
18
.\" Set up some character translations and predefined strings.  \*(-- will
 
19
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 
20
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
 
21
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
 
22
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
 
23
.\" nothing in troff, for use with C<>.
 
24
.tr \(*W-
 
25
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 
26
.ie n \{\
 
27
.    ds -- \(*W-
 
28
.    ds PI pi
 
29
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
30
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 
31
.    ds L" ""
 
32
.    ds R" ""
 
33
.    ds C` ""
 
34
.    ds C' ""
 
35
'br\}
 
36
.el\{\
 
37
.    ds -- \|\(em\|
 
38
.    ds PI \(*p
 
39
.    ds L" ``
 
40
.    ds R" ''
 
41
'br\}
 
42
.\"
 
43
.\" Escape single quotes in literal strings from groff's Unicode transform.
 
44
.ie \n(.g .ds Aq \(aq
 
45
.el       .ds Aq '
 
46
.\"
 
47
.\" If the F register is turned on, we'll generate index entries on stderr for
 
48
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 
49
.\" entries marked with X<> in POD.  Of course, you'll have to process the
 
50
.\" output yourself in some meaningful fashion.
 
51
.ie \nF \{\
 
52
.    de IX
 
53
.    tm Index:\\$1\t\\n%\t"\\$2"
 
54
..
 
55
.    nr % 0
 
56
.    rr F
 
57
.\}
 
58
.el \{\
 
59
.    de IX
 
60
..
 
61
.\}
 
62
.\"
 
63
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
64
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
65
.    \" fudge factors for nroff and troff
 
66
.if n \{\
 
67
.    ds #H 0
 
68
.    ds #V .8m
 
69
.    ds #F .3m
 
70
.    ds #[ \f1
 
71
.    ds #] \fP
 
72
.\}
 
73
.if t \{\
 
74
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
75
.    ds #V .6m
 
76
.    ds #F 0
 
77
.    ds #[ \&
 
78
.    ds #] \&
 
79
.\}
 
80
.    \" simple accents for nroff and troff
 
81
.if n \{\
 
82
.    ds ' \&
 
83
.    ds ` \&
 
84
.    ds ^ \&
 
85
.    ds , \&
 
86
.    ds ~ ~
 
87
.    ds /
 
88
.\}
 
89
.if t \{\
 
90
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
91
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
92
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
93
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
94
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
95
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
96
.\}
 
97
.    \" troff and (daisy-wheel) nroff accents
 
98
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
99
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
100
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
101
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
102
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
103
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
104
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
105
.ds ae a\h'-(\w'a'u*4/10)'e
 
106
.ds Ae A\h'-(\w'A'u*4/10)'E
 
107
.    \" corrections for vroff
 
108
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
109
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
110
.    \" for low resolution devices (crt and lpr)
 
111
.if \n(.H>23 .if \n(.V>19 \
 
112
\{\
 
113
.    ds : e
 
114
.    ds 8 ss
 
115
.    ds o a
 
116
.    ds d- d\h'-1'\(ga
 
117
.    ds D- D\h'-1'\(hy
 
118
.    ds th \o'bp'
 
119
.    ds Th \o'LP'
 
120
.    ds ae ae
 
121
.    ds Ae AE
 
122
.\}
 
123
.rm #[ #] #H #V #F C
 
124
.\" ========================================================================
 
125
.\"
 
126
.IX Title "RRDFLUSHCACHED 1"
 
127
.TH RRDFLUSHCACHED 1 "2009-10-14" "1.4.3" "rrdtool"
 
128
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 
129
.\" way too many mistakes in technical documents.
 
130
.if n .ad l
 
131
.nh
 
132
.SH "NAME"
 
133
rrdflushcached \- Flush the values for a spcific RRD file from memory.
 
134
.SH "SYNOPSIS"
 
135
.IX Header "SYNOPSIS"
 
136
\&\fBrrdtool\fR \fBflushcached\fR
 
137
[\fB\-\-daemon\fR\ \fIaddress\fR]
 
138
\&\fIfilename\fR [\fIfilename\fR ...]
 
139
.SH "DESCRIPTION"
 
140
.IX Header "DESCRIPTION"
 
141
The \fBflushcached\fR function connects to rrdcached, the \s-1RRD\s0 caching daemon,
 
142
and issues a \*(L"flush\*(R" command for the given files. The daemon will put the
 
143
files to the head of the update queue so they are written \*(L"soon\*(R". The
 
144
status will be returned only after the files' pending updates have been
 
145
written to disk.
 
146
.IP "\fIfilename\fR" 8
 
147
.IX Item "filename"
 
148
The name(s) of the \fB\s-1RRD\s0\fR file(s) that are to be written to disk.
 
149
.IP "\fB\-\-daemon\fR \fIaddress\fR" 8
 
150
.IX Item "--daemon address"
 
151
Address of the rrdcached daemon. If not specified, the
 
152
\&\s-1RRDCACHED_ADDRESS\s0 environment variable must be set (see below).  For a
 
153
list of accepted formats, see the \fB\-l\fR option in the rrdcached
 
154
manual.
 
155
.Sp
 
156
.Vb 1
 
157
\& rrdtool flush \-\-daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
 
158
.Ve
 
159
.SH "ENVIRONMENT VARIABLES"
 
160
.IX Header "ENVIRONMENT VARIABLES"
 
161
The following environment variables may be used to change the behavior of
 
162
\&\f(CW\*(C`rrdtool\ flushcached\*(C'\fR:
 
163
.IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4
 
164
.IX Item "RRDCACHED_ADDRESS"
 
165
If this environment variable is set it will have the same effect as specifying
 
166
the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command
 
167
line argument takes precedence.
 
168
.SH "AUTHOR"
 
169
.IX Header "AUTHOR"
 
170
Florian Forster <octo\ at\ verplant.org>