'\" t .\" Title: cmis-client .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 2018-12-23 .\" Manual: libcmis 0.6.3 .\" Source: libcmis 0.6.3 .\" Language: English .\" .TH "CMIS\-CLIENT" "1" "2018\-12\-23" "libcmis 0.6.3" "libcmis 0.6.3" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" ______cmis-client ____ \- command line CMIS client tool\&. .SH "SYNOPSIS" .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR help .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] \-\-url\ \fIurl://to/binding\fR list\-repos .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR repo\-infos .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR show\-root .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR get\-content\ \fIid\fR .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR \-\-input\-file\ \fIpath/to/file\fR \-\-input\-type\ \fImime/type\fR [\-\-input\-name\ \fIname\&.ext\fR] set\-content\ \fIid\fR .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR [\-\-object\-type\ \fIsome:cmistype\fR] [\-\-object\-property\ \fIprop\-id=prop\-value\fR...] create\-folder\ \fIparent\-id\ name\fR .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR \-\-input\-file\ \fIpath/to/file\fR \-\-input\-type\ \fImime/type\fR [\-\-input\-name\ \fIname\&.ext\fR] [\-\-object\-type\ \fIsome:cmistype\fR] [\-\-object\-property\ \fIprop\-id=prop\-value\fR...] create\-document\ \fIparent\-id\ name\fR .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR [\-\-object\-property\ \fIprop\-id=prop\-value\fR...] update\-object\ \fIobject\-id\fR .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR [type\-by\-id] | [show\-by\-id] | [show\-by\-path] | [delete] \fIarg\fR... .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR [checkout] | [cancel\-checkout] | [get\-versions] \fIarg\fR .HP \w'\fBcmis\-client\fR\ 'u \fBcmis\-client\fR [\-v] [\-u\ \fIlogin\fR] [\-p\ \fIsecret\fR] \-\-url\ \fIurl://to/binding\fR \-r\ \fIrepo\-id\fR [\-\-input\-file\ \fIpath/to/file\fR] [\-\-input\-type\ \fImime/type\fR] [\-\-input\-name\ \fIname\&.ext\fR] [\-\-object\-property\ \fIprop\-id=prop\-value\fR...] [\-\-major] [\-\-message] checkin\ \fIpwc\ id\fR .SH "DESCRIPTION" .PP The \fBcmis\-client\fR tool sends queries over the net to a CMIS\-enabled server to access or modify its content\&. It is originally demonstrating what libcmis is capable of\&. .SH "OPTIONS" .SS "GLOBAL OPTIONS" .PP \-v, \-\-verbose .RS 4 Shows a lot of information to monitor what is happening behind the scene\&. This helps a lot to debug libcmis\&. .RE .PP \-\-help .RS 4 Show the help and exit\&. This is equivalent to use the help command\&. .RE .PP \-\-url \fIurl://to/binding\fR .RS 4 \fIurl://to/binding\fR needs to point to the service document of either AtomPub or WebService binding\&. .RE .PP \-r,\-\-repository \fIrepo\-id\fR .RS 4 Operate on the \fIrepo\-id\fR CMIS repository\&. If there is only one repository on the server, this parameter is not needed and that repository will be automatically selected\&. Use this parameter if there are several repositories on the server\&. .RE .PP \-u,\-\-username \fIlogin\fR .RS 4 Connect as \fIlogin\fR to the CMIS server\&. If not provided connect anonymously\&. .RE .PP \-p,\-\-password \fIsecret\fR .RS 4 Use \fIsecret\fR to authenticate on the CMIS server\&. .RE .PP \-\-no\-ssl\-check .RS 4 Disables the SSL certificate verifications\&. Lowers the security, but may be handy to work around bad certificates like expired or self\-signed ones\&. .RE .PP \-\-proxy \fIurl\fR .RS 4 Use \fIurl\fR as the HTTP proxy\&. Setting this value will override the system proxy settings\&. .RE .PP \-\-proxy\-username \fIlogin\fR .RS 4 Use \fIlogin\fR to authenticate on the HTTP proxy\&. .RE .PP \-\-proxy\-password \fIsecret\fR .RS 4 Use \fIsecret\fR to authenticate on the HTTP proxy\&. .RE .PP \-\-noproxy \fIlist\fR .RS 4 Proxy settings won\*(Aqt apply to hostnames and domain names listed in \fIlist\fR\&. This value is a coma separated list\&. .RE .PP \-\-oauth2\-client\-id \fIclient_id\fR .RS 4 Application client id to use in the OAuth2 authentication flow\&. .RE .PP \-\-oauth2\-client\-secret \fIclient_secret\fR .RS 4 Application client secret to use in the OAuth2 authentication flow\&. .RE .PP \-\-oauth2\-auth\-url \fIurl\fR .RS 4 URL to authenticate the user in the OAuth2 authentication flow\&. .RE .PP \-\-oauth2\-token\-url \fIurl\fR .RS 4 URL to authenticate the application in the OAuth2 authentication flow\&. The access and refresh tokens are provided by this URL\&. .RE .PP \-\-oauth2\-redirect\-uri \fIuri\fR .RS 4 URI where the OAuth2 authentication flow will redirect after a sucessful authentication\&. .RE .PP \-\-oauth2\-scope \fIscope\fR .RS 4 Requested scope to access in the OAuth2 authentication flow\&. .RE .SS "MODIFICATION OPERATIONS OPTIONS" .PP \-\-input\-file \fIpath/to/file\fR .RS 4 Upload \fIpath/to/file\fR as the new content stream of the object\&. .RE .PP \-\-input\-type \fImime/type\fR .RS 4 Set the mime type of the new content stream of the object to \fImime/type\fR\&. .RE .PP \-\-input\-name \fIname\&.ext\fR .RS 4 Set the remote content stream filename of the new content stream of the object to \fIname\&.ext\fR\&. .RE .PP \-\-object\-type \fIsome:cmistype\fR .RS 4 Set the object type of the CMIS object to be created to \fIsome:cmistype\fR\&. This is the equivalent of \-\-object\-property cmis:objectTypeId=some:cmistype\&. .RE .PP \-\-object\-property \fIprop\-id=prop\-value\fR .RS 4 Set a property to be updated or added to the CMIS object\&. \fIprop\-id\fR is the property definition id and \fIprop\-value\fR is the value to set on it\&. .RE .PP \-\-major .RS 4 Create a major version when performing a checkin\&. .RE .PP \-m, \-\-message \fImessage\fR .RS 4 Set the checking message\&. .RE .SS "COMMANDS" .PP help .RS 4 Show the help and exit\&. .RE .PP list\-repos .RS 4 List the repositories available on the server\&. .RE .PP repo\-infos .RS 4 Displays the informations and capabilities of the selected repository .RE .PP show\-root .RS 4 Displays the root node infos and children\&. .RE .PP get\-content \fIid\fR .RS 4 Download the content of the CMIS object corresponding to \fIid\fR in the current directory\&. .RE .PP set\-content \fIid\fR .RS 4 Upload a file as the content stream of the CMIS object corresponding to \fIid\fR\&. .RE .PP create\-folder \fIparent\-id name\fR .RS 4 Create a sub folder in folder \fIparent\-id\fR named \fIname\fR\&. The default type of the folder to create is cmis:folder, but this can be changed using \-\-object\-type option\&. .RE .PP create\-document \fIparent\-id name\fR .RS 4 Create a document in folder \fIparent\-id\fR named \fIname\fR\&. The default type of the document to create is cmis:document, but this can be changed using \-\-object\-type option\&. .sp Note that the \-\-input\-file and \-\-input\-type may be mandatory, depending on the type of the document to create and its constraints\&. .RE .PP update\-object \fIobject\-id\fR .RS 4 Replace the writeable properties given with \-\-object\-property option on the object matching id \fIobject\-id\fR\&. .RE .PP type\-by\-id \fIarg\&.\&.\&.\fR .RS 4 Displays the infos and children (if any) of all the CMIS types corresponding to the listed ids\&. .RE .PP show\-by\-id \fIarg\&.\&.\&.\fR .RS 4 Displays the infos and children (if any) of all the CMIS objects corresponding to the listed ids\&. .RE .PP show\-by\-path \fIarg\&.\&.\&.\fR .RS 4 Displays the infos and children (if any) of all the CMIS objects corresponding to the listed paths\&. .RE .PP delete \fIarg\&.\&.\&.\fR .RS 4 Deletes the CMIS objects corresponding to the listed ids\&. If the node is a folder, its content will be removed as well\&. .RE .PP checkout \fIarg\fR .RS 4 Checkout the document corresponding to the provided id and display the infos of the created private working copy\&. .RE .PP cancel\-checkout \fIarg\fR .RS 4 Cancel the Private Working Copy corresponding to the node id\&. .RE .PP get\-versions \fIarg\fR .RS 4 Display the versions (if any) of all the CMIS object corresponding to the provided id\&. .RE .PP checkin \fIarg\fR .RS 4 Check in the private working copy corresponding to the provided id and display the infos of the resulting document\&. Use the \-\-major and \-\-message options to define the version to create and the commit to associate to it\&. Note that repositories without the ability to update the private working copies will need the \-\-input\-file, \-\-input\-type and \-\-object\-property options\&. .RE .SH "USAGE" .PP Displays the root node of repository A1: .PP \fBcmis\-client\fR \-r A1 \-\-url http://localhost/atom show\-root .PP Displays the nodes with id 133 and 116 of repository A1: .PP \fBcmis\-client\fR \-r A1 \-\-url http://localhost/atom show\-by id 133 116 .SH "AUTHOR" .PP C\('edric Bosdonnat .SH "REPORTING BUGS" .PP Report bugs to <\m[blue]\fBhttps://github\&.com/tdf/libcmis/issues\fR\m[]>\&.