github.com/olivere/camlistore@v0.0.0-20140121221811-1b7ac2da0199/cmd/camput/doc.go (about)

     1  /*
     2  Copyright 2013 The Camlistore Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8       http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  /*
    18  The camput tool mainly pushes blobs, files, and directories. It can also perform various related tasks, such as setting tags, creating permanodes, and creating share blobs.
    19  
    20  
    21  Usage:
    22  
    23  	camput [globalopts] <mode> [commandopts] [commandargs]
    24  
    25  Modes:
    26  
    27    init: Initialize the camput configuration file.
    28    share: Grant access to a resource by making a "share" blob.
    29    rawobj: Upload a custom JSON schema blob.
    30    attr: Add, set, or delete a permanode's attribute.
    31    file: Upload file(s).
    32    blob: Upload raw blob(s).
    33    permanode: Create and upload a permanode.
    34  
    35  Examples:
    36  
    37    camput file [opts] <file(s)/director(ies)
    38    camput file --permanode --name='Homedir backup' --tag=backup,homedir $HOME
    39    camput file --filenodes /mnt/camera/DCIM
    40  
    41    camput blob <files>     (raw, without any metadata)
    42    camput blob -           (read from stdin)
    43  
    44    camput permanode                                (create a new permanode)
    45    camput permanode -name="Some Name" -tag=foo,bar (with attributes added)
    46  
    47    camput init
    48    camput init --gpgkey=XXXXX
    49  
    50    camput share [opts] <blobref to share via haveref>
    51  
    52    camput rawobj (debug command)
    53  
    54    camput attr <permanode> <name> <value>         Set attribute
    55    camput attr --add <permanode> <name> <value>   Adds attribute (e.g. "tag")
    56    camput attr --del <permanode> <name> [<value>] Deletes named attribute [value
    57  
    58  For mode-specific help:
    59  
    60    camput <mode> -help
    61  
    62  Global options:
    63    -help=false: print usage
    64    -secret-keyring="~/.gnupg/secring.gpg": GnuPG secret keyring file to use.
    65    -server="": Camlistore server prefix. If blank, the default from the "server" field of
    66    ~/.camlistore/config is used.
    67    Acceptable forms: https://you.example.com, example.com:1345 (https assumed),
    68    or http://you.example.com/alt-root
    69    -verbose=false: extra debug logging
    70    -verbose_http=false: show HTTP request summaries
    71    -version=false: show version
    72  */
    73  package main