Code

Imported upstream version 1.4.3.
[pkg-rrdtool.git] / doc / rrdcached.txt
index a550a5613af4ce7025839b4f7df1e03f41e2b9cd..f2091de9c0309936b43c3af8437be656f4b806a7 100644 (file)
@@ -6,9 +6,9 @@ N\bNA\bAM\bME\bE
        rrdcached - Data caching daemon for rrdtool
 
 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
-       r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd [-\b-P\bP _\bp_\be_\br_\bm_\bi_\bs_\bs_\bi_\bo_\bn_\bs] [-\b-l\bl _\ba_\bd_\bd_\br_\be_\bs_\bs] [-\b-w\bw _\bt_\bi_\bm_\be_\bo_\bu_\bt] [-\b-z\bz _\bd_\be_\bl_\ba_\by]
-       [-\b-f\bf _\bt_\bi_\bm_\be_\bo_\bu_\bt] [-\b-p\bp _\bp_\bi_\bd_\b__\bf_\bi_\bl_\be] [-\b-t\bt _\bw_\br_\bi_\bt_\be_\b__\bt_\bh_\br_\be_\ba_\bd_\bs] [-\b-j\bj _\bj_\bo_\bu_\br_\bn_\ba_\bl_\b__\bd_\bi_\br] [-F]
-       [-g] [-\b-b\bb _\bb_\ba_\bs_\be_\b__\bd_\bi_\br [-\b-B\bB]]
+       r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd [-\b-P\bP _\bp_\be_\br_\bm_\bi_\bs_\bs_\bi_\bo_\bn_\bs] [-\b-l\bl _\ba_\bd_\bd_\br_\be_\bs_\bs] [-\b-s\bs _\bg_\br_\bo_\bu_\bp] [-\b-w\bw _\bt_\bi_\bm_\be_\bo_\bu_\bt]
+       [-\b-z\bz _\bd_\be_\bl_\ba_\by] [-\b-f\bf _\bt_\bi_\bm_\be_\bo_\bu_\bt] [-\b-p\bp _\bp_\bi_\bd_\b__\bf_\bi_\bl_\be] [-\b-t\bt _\bw_\br_\bi_\bt_\be_\b__\bt_\bh_\br_\be_\ba_\bd_\bs]
+       [-\b-j\bj _\bj_\bo_\bu_\br_\bn_\ba_\bl_\b__\bd_\bi_\br] [-F] [-g] [-\b-b\bb _\bb_\ba_\bs_\be_\b__\bd_\bi_\br [-\b-B\bB]]
 
 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
        r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd is a daemon that receives updates to existing RRD files,
@@ -30,7 +30,7 @@ O\bOP\bPT\bTI\bIO\bON\bNS\bS
            on that socket. If _\ba_\bd_\bd_\br_\be_\bs_\bs begins with "unix:", everything
            following that prefix is interpreted as the path to a UNIX domain
            socket. Otherwise the address or node name are resolved using
-           getaddrinfo.
+           "getaddrinfo()".
 
            For network sockets, a port may be specified by using the form
            "[\b[_\ba_\bd_\bd_\br_\be_\bs_\bs]\b]:\b:_\bp_\bo_\br_\bt_\b". If the address is an IPv4 address or a fully
@@ -52,6 +52,40 @@ O\bOP\bPT\bTI\bIO\bON\bNS\bS
            If the -\b-l\bl option is not specified the default address,
            "unix:/tmp/rrdcached.sock", will be used.
 
+       -\b-s\bs _\bg_\br_\bo_\bu_\bp_\b__\bn_\ba_\bm_\be|_\bg_\bi_\bd
+           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 _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg UNIX socket addresses (the
+           following -\b-l\bl 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.
+
+       -\b-m\bm _\bm_\bo_\bd_\be
+           Set the file permissions of a UNIX domain socket. The option
+           accepts an octal number representing the bit pattern for the mode
+           (see _\bc_\bh_\bm_\bo_\bd(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 _\bu_\bn_\bi_\bx(7) for details.
+
+           This option affects the _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg UNIX socket addresses (the
+           following -\b-l\bl 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.
+
        -\b-P\bP _\bc_\bo_\bm_\bm_\ba_\bn_\bd[,_\bc_\bo_\bm_\bm_\ba_\bn_\bd[,...]]
            Specifies the commands accepted via a network socket. This allows
            administrators of _\bR_\bR_\bD_\bC_\ba_\bc_\bh_\be_\bD to control the actions accepted from
@@ -63,7 +97,7 @@ O\bOP\bPT\bTI\bIO\bON\bNS\bS
 
              rrdcached -P FLUSH,PENDING $MORE_ARGUMENTS
 
-           The -\b-P\bP option effects the _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg socket addresses (the following
+           The -\b-P\bP option affects the _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg socket addresses (the following
            -\b-l\bl options). In the following example, only the IPv4 network socket
            (address 10.0.0.1) will be restricted to the "FLUSH" and "PENDING"
            commands:
@@ -543,4 +577,4 @@ C\bCO\bON\bNT\bTR\bRI\bIB\bBU\bUT\bTO\bOR\bRS\bS
 
 
 
-1.4.2                             2009-11-15                      RRDCACHED(1)
+1.4.3                             2010-03-22                      RRDCACHED(1)