[Python-apps-commits] r8164 - in packages/graphite-carbon/trunk/debian (6 files)

Sun Feb 12 14:40:30 UTC 2012

Date: Sunday, February 12, 2012 @ 14:40:29
  Author: hggh-guest
Revision: 8164

added manpages 

Added:
  packages/graphite-carbon/trunk/debian/carbon-aggregator.1
  packages/graphite-carbon/trunk/debian/carbon-cache.1
  packages/graphite-carbon/trunk/debian/carbon-client.1
  packages/graphite-carbon/trunk/debian/carbon-relay.1
  packages/graphite-carbon/trunk/debian/graphite-carbon.manpages
  packages/graphite-carbon/trunk/debian/validate-storage-schemas.1

Added: packages/graphite-carbon/trunk/debian/carbon-aggregator.1
===================================================================

--- packages/graphite-carbon/trunk/debian/carbon-aggregator.1	                        (rev 0)
+++ packages/graphite-carbon/trunk/debian/carbon-aggregator.1	2012-02-12 14:40:29 UTC (rev 8164)
@@ -0,0 +1,56 @@
+.TH CARBON-AGGREGATOR 1
+.SH NAME
+carbon-aggregator \- buffer metrics over time before reporting to carbon-cache
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-aggregator\fP [options] start
+.fam T
+.fi
+.SH DESCRIPTION
+carbon-aggregator can be run in front of carbon-cache to buffer metrics over
+time before reporting them into whisper.
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Run in the foreground, log to stdout
+.TP
+.B
+\-\-profile=PROFILE
+Record performance profile data to the given file
+.TP
+.B
+\-\-pidfile=PIDFILE
+Write pid to the given file
+.TP
+.B
+\-\-config=CONFIG
+Use the given config file
+.TP
+.B
+\-\-logdir=LOGDIR
+Write logs in the given directory
+.TP
+.B
+\-\-instance=INSTANCE
+Manage a specific carbon instance
+.TP
+.B
+\-\-rules=RULES
+Use the given aggregation rules file.
+.TP
+.B
+\-\-rewrite-rules=REWRITE_RULES
+Use the given rewrite rules file.
+.SH AUTHOR
+\fBcarbon-aggregator\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt at capi2name.de, for
+the Debian project (but may be used by others).

Added: packages/graphite-carbon/trunk/debian/carbon-cache.1
===================================================================
--- packages/graphite-carbon/trunk/debian/carbon-cache.1	                        (rev 0)
+++ packages/graphite-carbon/trunk/debian/carbon-cache.1	2012-02-12 14:40:29 UTC (rev 8164)
@@ -0,0 +1,50 @@
+.TH CARBON-CACHE 1
+.SH NAME
+carbon-cache \- accepts metrics over various protocols and writes them to disk
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-cache\fP [options] start
+.fam T
+.fi
+.SH DESCRIPTION
+carbon-cache accepts metrics over various protocols and writes them to disk as
+efficiently as possible. This requires caching metric values in RAM as they are
+received, and flushing them to disk on an interval using the underlying
+whisper library.
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Run in the foreground, log to stdout
+.TP
+.B
+\-\-profile=PROFILE
+Record performance profile data to the given file
+.TP
+.B
+\-\-pidfile=PIDFILE
+Write pid to the given file
+.TP
+.B
+\-\-config=CONFIG
+Use the given config file
+.TP
+.B
+\-\-logdir=LOGDIR
+Write logs in the given directory
+.TP
+.B
+\-\-instance=INSTANCE
+Manage a specific carbon instance
+.SH AUTHOR
+\fBcarbon-cache\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt at capi2name.de, for
+the Debian project (but may be used by others).

Added: packages/graphite-carbon/trunk/debian/carbon-client.1
===================================================================
--- packages/graphite-carbon/trunk/debian/carbon-client.1	                        (rev 0)
+++ packages/graphite-carbon/trunk/debian/carbon-client.1	2012-02-12 14:40:29 UTC (rev 8164)
@@ -0,0 +1,43 @@
+.TH CARBON-CLIENT 1
+.SH NAME
+carbon-client \- Graphite client to reroute carbon data
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-client\fP [options]
+.fam T
+.fi
+.SH DESCRIPTION
+Graphite client to reroute carbon data
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Log debug info to stdout
+.TP
+.B
+\-\-keyfunc=KEYFUNC
+Use a custom key function (path/to/module.py:myFunc)
+.TP
+.B
+\-\-replication=REPLICATION
+Replication factor
+.TP
+.B
+\-\-routing=ROUTING
+Routing method: "consistent-hashing" (default) or "relay"
+.TP
+.B
+\-\-relayrules=RELAYRULES
+relay-rules.conf file to use for relay routing
+.SH AUTHOR
+\fBcarbon-client\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt at capi2name.de, for
+the Debian project (but may be used by others).

Added: packages/graphite-carbon/trunk/debian/carbon-relay.1
===================================================================
--- packages/graphite-carbon/trunk/debian/carbon-relay.1	                        (rev 0)
+++ packages/graphite-carbon/trunk/debian/carbon-relay.1	2012-02-12 14:40:29 UTC (rev 8164)
@@ -0,0 +1,51 @@
+.TH CARBON-RELAY 1
+.SH NAME
+carbon-relay \- replication and sharding data
+.SH SYNOPSYS
+.nf
+.fam C
+\fbcarbon-relay\fP [options] start
+.fam T
+.fi
+.SH DESCRIPTION
+carbon-relay serves two distinct purposes: replication and sharding.
+.PP
+The options are described below.
+.SH OPTIONS
+.TP
+.B
+\-h, \-\-help
+Show the embedded help.
+.TP
+.B
+\-\-debug
+Run in the foreground, log to stdout
+.TP
+.B
+\-\-profile=PROFILE
+Record performance profile data to the given file
+.TP
+.B
+\-\-pidfile=PIDFILE
+Write pid to the given file
+.TP
+.B
+\-\-config=CONFIG
+Use the given config file
+.TP
+.B
+\-\-logdir=LOGDIR
+Write logs in the given directory
+.TP
+.B
+\-\-instance=INSTANCE
+Manage a specific carbon instance
+.TP
+.B
+\-\-rules=RULES
+se the given relay rules file.
+.SH AUTHOR
+\fBcarbon-relay\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt at capi2name.de, for
+the Debian project (but may be used by others).

Added: packages/graphite-carbon/trunk/debian/graphite-carbon.manpages
===================================================================
--- packages/graphite-carbon/trunk/debian/graphite-carbon.manpages	                        (rev 0)
+++ packages/graphite-carbon/trunk/debian/graphite-carbon.manpages	2012-02-12 14:40:29 UTC (rev 8164)
@@ -0,0 +1,5 @@
+debian/carbon-aggregator.1
+debian/carbon-cache.1
+debian/carbon-client.1
+debian/carbon-relay.1
+debian/validate-storage-schemas.1

Added: packages/graphite-carbon/trunk/debian/validate-storage-schemas.1
===================================================================
--- packages/graphite-carbon/trunk/debian/validate-storage-schemas.1	                        (rev 0)
+++ packages/graphite-carbon/trunk/debian/validate-storage-schemas.1	2012-02-12 14:40:29 UTC (rev 8164)
@@ -0,0 +1,17 @@
+.TH VALIDATE-STORAGE-SCHEMAS 1
+.SH NAME
+validate-storage-schemas \- validates the storage schemas
+.SH SYNOPSYS
+.nf
+.fam C
+\fbvalidate-storage-schemas\fP
+.fam T
+.fi
+.SH DESCRIPTION
+validates the storage schemas from the configuration
+file /etc/carbon/storage-schemas.conf.
+.SH AUTHOR
+\fBvalidate-storage-schemas\fP, created by Chris Davis.
+.PP
+This manual page was written by Jonas Genannt <jonas.genannt at capi2name.de, for
+the Debian project (but may be used by others).


