From 26cbd36e0b3a232563a86a420251904fca3c1c98 Mon Sep 17 00:00:00 2001 From: Brad Fitzpatrick Date: Thu, 27 Feb 2014 21:23:01 -0800 Subject: [PATCH] camput, camtool: update docs Change-Id: If54df42be3b95ec9f10782454bc247449e1a74e6 --- cmd/camput/doc.go | 11 ++++++----- cmd/camtool/doc.go | 24 ++++++++++++++++-------- 2 files changed, 22 insertions(+), 13 deletions(-) diff --git a/cmd/camput/doc.go b/cmd/camput/doc.go index 5dd935fd7..991c0a5fb 100644 --- a/cmd/camput/doc.go +++ b/cmd/camput/doc.go @@ -20,17 +20,18 @@ The camput tool mainly pushes blobs, files, and directories. It can also perform Usage: - camput [globalopts] [commandopts] [commandargs] + camput [globalopts] [commandopts] [commandargs] Modes: - init: Initialize the camput configuration file. - share: Grant access to a resource by making a "share" blob. - rawobj: Upload a custom JSON schema blob. + delete: Create and upload a delete claim. attr: Add, set, or delete a permanode's attribute. file: Upload file(s). - blob: Upload raw blob(s). + init: Initialize the camput configuration file. With no option, it tries to use the GPG key found in the default identity secret ring. permanode: Create and upload a permanode. + rawobj: Upload a custom JSON schema blob. + share: Grant access to a resource by making a "share" blob. + blob: Upload raw blob(s). Examples: diff --git a/cmd/camtool/doc.go b/cmd/camtool/doc.go index b5c726a35..25d58f304 100644 --- a/cmd/camtool/doc.go +++ b/cmd/camtool/doc.go @@ -15,27 +15,35 @@ limitations under the License. */ /* -Camtool is a collection of commands to help with the use of a camlistore server. Notably, it can initialize a database for the indexer, and it can sync blobs between blobservers. - +The camtool binary is a collection of commands to help with the use of +a camlistore server. Notably, it can initialize a database for the +indexer, and it can sync blobs between blobservers. Usage: - camtool [globalopts] [commandopts] [commandargs] + camtool [globalopts] [commandopts] [commandargs] Modes: + env: Return Camlistore environment information + gsinit: Init Google Storage. + list: List blobs on a server. + claims: Ask the search system to list the claims that modify a permanode. + dumpconfig: Dump the low-level server config from its simple config. + describe: Ask the search system to describe one or more blobs. + discovery: Perform configuration discovery against a server. + reindex-diskpacked: Rebuild the index of the diskpacked blob store + index: Synchronize blobs for all discovered blobs storage - indexer pairs. sync: Synchronize blobs from a source to a destination. dbinit: Set up the database for the indexer. - gsinit: Init Google Storage. debug: Show misc meta-info from the given file. Examples: - camtool dbinit -user root -password root -host localhost -dbname camliprod -wipe - camtool sync --all - camtool sync --src=http://localhost:3179/bs/ --dest=http://localhost:3179/index-mem/ - camtool sync --src=http://localhost:3179/bs/ --dest=/tmp/some/path + camtool sync --src http://localhost:3179/bs/ --dest http://localhost:3179/index-mem/ + + camtool dbinit -user root -password root -host localhost -dbname camliprod -wipe For mode-specific help: