mt-libcouchbase 1.4.0

data/ext/libcouchbase/doc/man/cbcrc.4

@@ -0,0 +1,71 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CBCRC" "4" "October 2018" "" ""
+.
+.SH "NAME"
+\fBcbcrc\fR \- Configuration file for Couchbase command line tools
+.
+.SH "SYNOPSIS"
+\fB~/\.cbcrc\fR
+.
+.SH "DESCRIPTION"
+cbcrc is an optional configuration file used to provide default values for the cbc(1) and cbc\-pillowfight(1) utilities\. It should be placed in
+.
+.P
+Each entry in the cbcrc file is a line with a key\-value pair in the following form:
+.
+.IP "" 4
+.
+.nf
+
+# optional comments
+key=value
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The keys may be specified in random order, and if you specify the same key multiple times the last value "wins"\. The following keys exists:
+.
+.TP
+\fBconnstr\fR
+This is the URI\-like string used to connect to the cluster\. Its format consists of a \fIscheme\fR followed by a list of hosts, an optional bucket for the path and an optional \fB?\fR followed by key\-value options\.
+.
+.IP
+Using custom REST API ports
+.
+.IP
+http://localhost:9000,localhost:9001,localhost:9002
+.
+.IP
+Using custom memcached ports:
+.
+.IP
+couchbase://localhost:9100,localhost:9200,localhost:9300
+.
+.TP
+\fBuser\fR
+This is the user name used during authentication to your bucket
+.
+.TP
+\fBpassword\fR
+This is the password used during authentication to your bucket
+.
+.TP
+\fBtimeout\fR
+The timeout value to use for the operations\.
+.
+.SH "NOTES"
+.
+.IP "\(bu" 4
+You can generate such a file from the cbc(1) itself using the \fBwrite\-config\fR subcommand
+.
+.IP "\(bu" 4
+Most other options can be specified within the connection string
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+cbc(1), cbc\-pillowfight(1)