X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdcached.pod;h=d6bfec39c41bbd2afb071c65d268b841a5b219fa;hb=cd97eb45fb5fe5b964e2cf1584c02a931ec43b95;hp=043e020a30760214da0130b3d3731ac1c5b84991;hpb=dc4997373f9cc1c170bc378ff12fa2c3a23161e9;p=rrdtool.git

diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod
index 043e020..d6bfec3 100644
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -9,6 +9,7 @@ rrdcached - Data caching daemon for rrdtool
 B<rrdcached>
 [B<-P>E<nbsp>I<permissions>]
 [B<-l>E<nbsp>I<address>]
+[B<-s>E<nbsp>I<group>]
 [B<-w>E<nbsp>I<timeout>]
 [B<-z>E<nbsp>I<delay>]
 [B<-f>E<nbsp>I<timeout>]
@@ -30,8 +31,8 @@ work with up-to-date data.
 The daemon was written with big setups in mind. Those setups usually run into
 IOE<nbsp>related problems sooner or later for reasons that are beyond the scope
 of this document. Check the wiki at the RRDtool homepage for details. Also
-check L<SECURITY CONSIDERATIONS> below before using this daemon! A detailed
-description of how the daemon operates can be found in the L<HOW IT WORKS>
+check L</"SECURITY CONSIDERATIONS"> below before using this daemon! A detailed
+description of how the daemon operates can be found in the L</"HOW IT WORKS">
 section below.
 
 =head1 OPTIONS
@@ -43,7 +44,7 @@ section below.
 Tells the daemon to bind to I<address> and accept incoming connections on that
 socket. If I<address> begins with C<unix:>, everything following that prefix is
 interpreted as the path to a UNIX domain socket. Otherwise the address or node
-name are resolved using L<getaddrinfo>.
+name are resolved using C<getaddrinfo()>.
 
 For network sockets, a port may be specified by using the form
 C<B<[>I<address>B<]:>I<port>>. If the address is an IPv4 address or a fully
@@ -65,6 +66,41 @@ domain socket B<must> start with a slash in the second case!
 If the B<-l> option is not specified the default address,
 C<unix:/tmp/rrdcached.sock>, will be used.
 
+=item B<-s> I<group_name>|I<gid>
+
+Set the group permissions of a UNIX domain socket. The option accepts either
+a numeric group id or group name. That group will then have both read and write
+permissions (the socket will have file permissions 0750) for the socket and,
+therefore, is able to send commands to the daemon. This
+may be useful in cases where you cannot easily run all RRD processes with the same
+user privileges (e.g. graph generating CGI scripts that typically run in the
+permission context of the web server).
+
+This option affects the I<following> UNIX socket addresses (the following
+B<-l> options), i.e., you may specify different settings for different
+sockets.
+
+The default is not to change ownership or permissions of the socket and, thus,
+use the system default.
+
+=item B<-m> I<mode>
+
+Set the file permissions of a UNIX domain socket. The option accepts an octal
+number representing the bit pattern for the mode (see L<chmod(1)> for
+details).
+
+Please note that not all systems honor this setting. On Linux, read/write
+permissions are required to connect to a UNIX socket. However, many
+BSD-derived systems ignore permissions for UNIX sockets. See L<unix(7)> for
+details.
+
+This option affects the I<following> UNIX socket addresses (the following
+B<-l> options), i.e., you may specify different settings for different
+sockets.
+
+The default is not to change ownership or permissions of the socket and, thus,
+use the system default.
+
 =item B<-P> I<command>[,I<command>[,...]]
 
 Specifies the commands accepted via a network socket. This allows
@@ -76,7 +112,7 @@ For example, to allow the C<FLUSH> and C<PENDING> commands one could specify:
 
   rrdcached -P FLUSH,PENDING $MORE_ARGUMENTS
 
-The B<-P> option effects the I<following> socket addresses (the following B<-l>
+The B<-P> option affects the I<following> socket addresses (the following B<-l>
 options). In the following example, only the IPv4 network socket (address
 C<10.0.0.1>) will be restricted to the C<FLUSH> and C<PENDING> commands:
 
@@ -204,27 +240,47 @@ containing C<../> will also be blocked.
 The following commands may be made aware of the B<rrdcached> using the command
 line argument B<--daemon> or the environment variable B<RRDCACHED_ADDRESS>:
 
-=over 4
+=over
+
+=item *
+
+dump
+
+=item *
 
-=item B<dump>
+fetch
 
-=item B<fetch>
+=item *
+
+flush
+
+=item *
+
+graph
+
+=item *
+
+graphv
 
-=item B<flush>
+=item *
+
+info
+
+=item *
 
-=item B<graph>
+last
 
-=item B<graphv>
+=item *
 
-=item B<info>
+lastupdate
 
-=item B<last>
+=item *
 
-=item B<lastupdate>
+update
 
-=item B<update>
+=item *
 
-=item B<xport>
+xport
 
 =back
 
@@ -239,7 +295,7 @@ The daemon reports errors in one of two ways: During startup, error messages
 are printed to C<STDERR>. One of the steps when starting up is to fork to the
 background and closing C<STDERR> - after this writing directly to the user is
 no longer possible. Once this has happened, the daemon will send log messages
-to the system logging daemon using L<syslog(3)>. The facility used is
+to the system logging daemon using syslog(3). The facility used is
 C<LOG_DAEMON>.
 
 =head1 HOW IT WORKS
@@ -254,7 +310,7 @@ diagram below) are appended to the tree node.
 When appending a value to a tree node, it is checked whether it's time to write
 the values to disk. Values are written to disk if
 S<C<now() - First E<gt>= timeout>>, where C<timeout> is the timeout specified
-using the B<-w> option, see L<OPTIONS>. If the values are "old enough" they
+using the B<-w> option, see L</OPTIONS>. If the values are "old enough" they
 will be enqueued in the "update queue", i.E<nbsp>e. they will be appended to
 the linked list shown below.  Because the tree nodes and the elements of the
 linked list are the same data structures in memory, any update to a file that
@@ -404,7 +460,7 @@ You have been warned.
 
 The daemon communicates with clients using a line based ASCII protocol which is
 easy to read and easy to type. This makes it easy for scripts to implement the
-protocol and possible for users to use L<telnet> to connect to the daemon
+protocol and possible for users to use telnet to connect to the daemon
 and test stuff "by hand".
 
 The protocol is line based, this means that each record consists of one or more
@@ -415,7 +471,7 @@ C<E<lt>LFE<gt>> ("line feed").
 After the connection has been established, the client is expected to send a
 "command". A command consists of the command keyword, possibly some arguments,
 and a terminating newline character. For a list of commands, see
-L<Valid Commands> below.
+L</"Valid Commands"> below.
 
 Example:
 
@@ -481,7 +537,7 @@ commands and usage summaries are returned is not well defined.
 
 Returns a list of metrics which can be used to measure the daemons performance
 and check its status. For a description of the values returned, see
-L<Performance Values> below.
+L</"Performance Values"> below.
 
 The format in which the values are returned is similar to many other line based
 protocols: Each value is printed on a separate line, each consisting of the
@@ -503,7 +559,7 @@ Example:
 =item B<UPDATE> I<filename> I<values> [I<values> ...]
 
 Adds more data to a filename. This is B<the> operation the daemon was designed
-for, so describing the mechanism again is unnecessary. Read L<HOW IT WORKS>
+for, so describing the mechanism again is unnecessary. Read L</"HOW IT WORKS">
 above for a detailed explanation.
 
 Note that rrdcached only accepts absolute timestamps in the update values.
@@ -631,8 +687,9 @@ L<rrdtool>, L<rrdgraph>
 
 =head1 AUTHOR
 
-B<rrdcached> and this manual page have been written by Florian Forster
-E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
+Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>
+
+Both B<rrdcached> and this manual page have been written by Florian.
 
 =head1 CONTRIBUTORS