You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
325 lines
13 KiB
325 lines
13 KiB
From b26784d5b6cab51e3119a706bcde01438478e310 Mon Sep 17 00:00:00 2001
|
|
From: David Tardon <dtardon@redhat.com>
|
|
Date: Sat, 15 Dec 2012 08:40:28 +0100
|
|
Subject: [PATCH 2/4] make the man page valid docbook
|
|
|
|
---
|
|
doc/cmis-client.xml | 300 ++++++++++++++++++++++++++--------------------------
|
|
1 file changed, 151 insertions(+), 149 deletions(-)
|
|
|
|
diff --git a/doc/cmis-client.xml b/doc/cmis-client.xml
|
|
index 22f041b..b7dce51 100644
|
|
--- a/doc/cmis-client.xml
|
|
+++ b/doc/cmis-client.xml
|
|
@@ -281,156 +281,158 @@
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>COMMANDS</title>
|
|
- <varlistentry>
|
|
- <term>help</term>
|
|
- <listitem>
|
|
- <para>
|
|
- Show the help and exit.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>list-repos</term>
|
|
- <listitem>
|
|
- <para>
|
|
- List the repositories available on the server.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>show-root</term>
|
|
- <listitem>
|
|
- <para>
|
|
- Displays the root node infos and children.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>get-content <replaceable class="parameter">id</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Download the content of the CMIS object corresponding to
|
|
- <replaceable class="parameter">id</replaceable> in the current directory.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>set-content <replaceable class="parameter">id</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Upload a file as the content stream of the CMIS object corresponding to
|
|
- <replaceable class="parameter">id</replaceable>.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>create-folder <replaceable class="parameter">parent-id name</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Create a sub folder in folder <replaceable class="parameter">parent-id</replaceable>
|
|
- named <replaceable class="parameter">name</replaceable>. The default type of the folder
|
|
- to create is cmis:folder, but this can be changed using --object-type option.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>create-document <replaceable class="parameter">parent-id name</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Create a document in folder <replaceable class="parameter">parent-id</replaceable>
|
|
- named <replaceable class="parameter">name</replaceable>. The default type of the document
|
|
- to create is cmis:document, but this can be changed using --object-type option.
|
|
- </para>
|
|
- <para>
|
|
- Note that the --input-file and --input-type may be mandatory, depending on the type of
|
|
- the document to create and its constraints.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>update-object <replaceable class="parameter">object-id</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Replace the writeable properties given with --object-property option on the object
|
|
- matching id <replaceable class="parameter">object-id</replaceable>.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>type-by-id <replaceable class="parameter">arg...</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Displays the infos and children (if any) of all the CMIS types corresponding
|
|
- to the listed ids.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>show-by-id <replaceable class="parameter">arg...</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Displays the infos and children (if any) of all the CMIS objects corresponding
|
|
- to the listed ids.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>show-by-path <replaceable class="parameter">arg...</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Displays the infos and children (if any) of all the CMIS objects corresponding
|
|
- to the listed paths.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>delete <replaceable class="parameter">arg...</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Deletes the CMIS objects corresponding to the listed ids. If the node
|
|
- is a folder, its content will be removed as well.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>checkout <replaceable class="parameter">arg</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Checkout the document corresponding to the provided id and display
|
|
- the infos of the created private working copy.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>cancel-checkout <replaceable class="parameter">arg</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Cancel the Private Working Copy corresponding to the node id.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>get-versions <replaceable class="parameter">arg</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- Display the versions (if any) of all the CMIS object corresponding
|
|
- to the provided id.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
- <varlistentry>
|
|
- <term>checkin <replaceable class="parameter">arg</replaceable></term>
|
|
- <listitem>
|
|
- <para>
|
|
- 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.
|
|
+ <variablelist>
|
|
+ <varlistentry>
|
|
+ <term>help</term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Show the help and exit.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>list-repos</term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ List the repositories available on the server.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>show-root</term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Displays the root node infos and children.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>get-content <replaceable class="parameter">id</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Download the content of the CMIS object corresponding to
|
|
+ <replaceable class="parameter">id</replaceable> in the current directory.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>set-content <replaceable class="parameter">id</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Upload a file as the content stream of the CMIS object corresponding to
|
|
+ <replaceable class="parameter">id</replaceable>.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>create-folder <replaceable class="parameter">parent-id name</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Create a sub folder in folder <replaceable class="parameter">parent-id</replaceable>
|
|
+ named <replaceable class="parameter">name</replaceable>. The default type of the folder
|
|
+ to create is cmis:folder, but this can be changed using --object-type option.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>create-document <replaceable class="parameter">parent-id name</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Create a document in folder <replaceable class="parameter">parent-id</replaceable>
|
|
+ named <replaceable class="parameter">name</replaceable>. The default type of the document
|
|
+ to create is cmis:document, but this can be changed using --object-type option.
|
|
+ </para>
|
|
+ <para>
|
|
+ Note that the --input-file and --input-type may be mandatory, depending on the type of
|
|
+ the document to create and its constraints.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>update-object <replaceable class="parameter">object-id</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Replace the writeable properties given with --object-property option on the object
|
|
+ matching id <replaceable class="parameter">object-id</replaceable>.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>type-by-id <replaceable class="parameter">arg...</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Displays the infos and children (if any) of all the CMIS types corresponding
|
|
+ to the listed ids.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>show-by-id <replaceable class="parameter">arg...</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Displays the infos and children (if any) of all the CMIS objects corresponding
|
|
+ to the listed ids.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>show-by-path <replaceable class="parameter">arg...</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Displays the infos and children (if any) of all the CMIS objects corresponding
|
|
+ to the listed paths.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>delete <replaceable class="parameter">arg...</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Deletes the CMIS objects corresponding to the listed ids. If the node
|
|
+ is a folder, its content will be removed as well.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>checkout <replaceable class="parameter">arg</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Checkout the document corresponding to the provided id and display
|
|
+ the infos of the created private working copy.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>cancel-checkout <replaceable class="parameter">arg</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Cancel the Private Working Copy corresponding to the node id.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>get-versions <replaceable class="parameter">arg</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ Display the versions (if any) of all the CMIS object corresponding
|
|
+ to the provided id.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ <varlistentry>
|
|
+ <term>checkin <replaceable class="parameter">arg</replaceable></term>
|
|
+ <listitem>
|
|
+ <para>
|
|
+ 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.
|
|
- </para>
|
|
- </listitem>
|
|
- </varlistentry>
|
|
+ Note that repositories without the ability to update the private working copies
|
|
+ will need the --input-file, --input-type and --object-property options.
|
|
+ </para>
|
|
+ </listitem>
|
|
+ </varlistentry>
|
|
+ </variablelist>
|
|
</refsect2>
|
|
</refsect1>
|
|
<refsect1>
|
|
--
|
|
1.8.0
|
|
|