[Pkg-owncloud-commits] [python-owncloud] 06/96: fixed documentation to display right I hope.

[Sandro Knauß]

This is an automated email from the git hooks/post-receive script.

hefee-guest pushed a commit to branch master
in repository python-owncloud.

commit 56bf69a1959d7cacda524cf0da2ce850b772f50b
Author: Craig Sawyer <csawyer at yumaed.org>
Date:   Sat Mar 9 19:37:50 2013 -0700

    fixed documentation to display right I hope.
---
 README.md |   88 ++++++++++++++++++++++++++++++++-----------------------------
 1 file changed, 46 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md
index 9ed3d6d..d3c0cdc 100644
--- a/README.md
+++ b/README.md
@@ -12,48 +12,52 @@ Requirements:
 
 usage: just run csync.py -h, and it will give you help.
 
-usage: csync.py [-h] [-v] [-c [CONFIG]] [-u [USER]] [-p [PASS]] [-d [DST]]
-                [src] [url]
-
-Synchronize files across machines using ownCloud DAV server
-
-positional arguments:
-  src                   local Directory to sync with
-  url                   url to sync to.
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -v, --version         show program's version number and exit
-  -c [CONFIG], --config [CONFIG]
-                        username on server.
-  -u [USER], --user [USER]
-                        username on server.
-  -p [PASS], --pass [PASS]
+    usage: csync.py [-h] [-v] [-c [CONFIG]] [-u [USER]] [--ssl [SSLFINGERPRINT]]
+                [-p [PASS]] [--dry-run] [-s [SRC]] [-d [DST]] [--url [URL]]
+
+    Synchronize files across machines using ownCloud DAV server
+
+    optional arguments:
+	    -h, --help            show this help message and exit
+      -v, --version
+      -c [CONFIG], --config [CONFIG]
+                            username on server.
+      -u [USER], --user [USER]
+                            username on server.
+      --ssl [SSLFINGERPRINT]
+                            SSL fingerprint on server to accept.
+      -p [PASS], --pass [PASS]
                         password on server. you can also store this in
                         environment variable OCPASS
-  -d [DST], --dst [DST]
+      --dry-run             Dry Run, do not actually execute command.
+      -s [SRC], --src [SRC]
+                        local Directory to sync with
+      -d [DST], --dst [DST]
                         fodler on server.
-
-I only support the 'ownCloud' section of the ownCloud config file.
-I support the following keys in the cfg  file:
-	user: The username on the ownCloud server
-	url: the url of the ownCloud Server
-	pass: the password on the ownCloud server
-	sslFingerprint: a valid SSL fingerprint for the server.
-	src: local directory to sync against.
-	dst: folder on the server to sync against.
-complete example:
-[ownCloud]
-user=awesomeSauce
-pass=PasswordThisIsSuperSuperSecretReallyISwearLOL
-url=url=https://www.example.org/owncloud/
-sslFingerprint=
-src=/home/awesomeSauce/ownCloud
-dst=clientsync
-
-Password options:
-  *) You can specify on the cmd line: -p (not very safe)
-  *) in the envifonment variable: OCPASS
-  *) in the owncloud.cfg file as pass = <password>
-  the choice is yours, if you put it in the cfg file, be careful to 
-  make sure nobody but you can read the file. (0400/0600 file perms)
+      --url [URL]           url to sync to.
+
+    I support the ownCloud config file, which is located here:
+      $HOME/.local/share/data/ownCloud/owncloud.cfg
+    I only support the 'ownCloud' section of the config.
+    I support the following keys in the cfg  file:
+        user: The username on the ownCloud server
+        url: the url of the ownCloud Server
+        pass: the password on the ownCloud server
+        sslFingerprint: a valid SSL fingerprint for the server.
+        src: local directory to sync against.
+        dst: folder on the server to sync against.
+    complete example:
+    [ownCloud]
+    user=awesomeSauce
+    pass=PasswordThisIsSuperSuperSecretReallyISwearLOL
+    url=url=https://www.example.org/owncloud/
+    sslFingerprint=
+    src=/home/awesomeSauce/ownCloud
+    dst=clientsync
+
+    Password options:
+      *) You can specify on the cmd line: -p (not very safe)
+      *) in the envifonment variable: OCPASS
+      *) in the owncloud.cfg file as pass = <password>
+      the choice is yours, if you put it in the cfg file, be careful to 
+      make sure nobody but you can read the file. (0400/0600 file perms)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/python-owncloud.git