[Pkg-owncloud-commits] [python-owncloud] 68/96: adding manpage for csync
Sandro Knauß
hefee-guest at moszumanska.debian.org
Fri Nov 22 01:28:28 UTC 2013
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 ff3b051fda8b219ee50aeffce7e8d8071c55a2d7
Author: hefee <hefee at netzguerilla.net>
Date: Wed Apr 3 18:07:49 2013 +0200
adding manpage for csync
---
doc/asciidoc.conf | 8 ++
doc/csync.1 | 228 +++++++++++++++++++++++++++++++++++++++++++++++++++++
doc/csync.1.txt | 124 +++++++++++++++++++++++++++++
doc/makeman.sh | 8 ++
4 files changed, 368 insertions(+)
diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf
new file mode 100644
index 0000000..4ae2a83
--- /dev/null
+++ b/doc/asciidoc.conf
@@ -0,0 +1,8 @@
+#
+# Customization for csync documentation.
+#
+[specialwords]
+ifndef::doctype-manpage[]
+emphasizedwords=(?u)\\?\bCSYNC\b
+monospacedwords=(?u)\\?\bcsync\(1\)
+endif::doctype-manpage[]
diff --git a/doc/csync.1 b/doc/csync.1
new file mode 100644
index 0000000..29d5288
--- /dev/null
+++ b/doc/csync.1
@@ -0,0 +1,228 @@
+'\" t
+.\" Title: csync
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 04/03/2013
+.\" Manual: \ \&
+.\" Source: \ \&
+.\" Language: English
+.\"
+.TH "CSYNC" "1" "04/03/2013" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * 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"
+csync \- ownCloud CLI client written in python
+.SH "SYNOPSIS"
+.sp
+\fBcsync\fR [\-h] [\-v] [\-c \fICONFIG\fR] [\-u \fIUSER\fR] [\-\-ssl \fISSLFINGERPRINT\fR] [\-p \fIPASS\fR] [\-\-dry\-run] [\-\-debug] [\-s \fISRC\fR] [\-d \fIDST\fR] [\-\-url \fIURL\fR] [\-\-use\-keyring]
+.SH "DESCRIPTION"
+.sp
+Syncing files across machines using ownCloud DAV server\&.
+.PP
+\fBPassword options:\fR
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+You can specify on the cmd line:
+\fB\-p\fR
+(not very safe)
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+In the environment variable:
+\fIOCPASS\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+In the owncloud\&.cfg file as
+\fBpass = \fR\fB\fI<password>\fR\fR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Use keyring to store passwords in a keyring (needs Python Keyring Lib to be installed)
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Do none of the above, and it will prompt you for the password
+.RE
+.sp
+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)\&.
+.SH "OPTIONS"
+.PP
+\fB\-c \fR\fB\fICONFIG\fR\fR\fB, \-\-config \fR\fB\fICONFIG\fR\fR
+.RS 4
+Configuration file to use
+.RE
+.PP
+\fB\-u \fR\fB\fIUSER\fR\fR\fB, \-\-user \fR\fB\fIUSER\fR\fR
+.RS 4
+Username on the ownCloud server
+.RE
+.PP
+\fB\-p \fR\fB\fIPASS\fR\fR\fB, \-\-pass \fR\fB\fIPASS\fR\fR
+.RS 4
+Password on the ownCloud server ( You can also store this in environment variable
+\fIOCPASS\fR
+)
+.RE
+.PP
+\fB\-s \fR\fB\fISRC\fR\fR\fB, \-\-src \fR\fB\fISRC\fR\fR
+.RS 4
+Local directory to sync against
+.RE
+.PP
+\fB\-d \fR\fB\fIDST\fR\fR\fB, \-\-dst \fR\fB\fIDST\fR\fR
+.RS 4
+Folder on server to sync against
+.RE
+.PP
+\fB\-\-url \fR\fB\fIURL\fR\fR
+.RS 4
+URL of the ownCloud server
+.RE
+.PP
+\fB\-\-ssl \fR\fB\fISSLFINGERPRINT\fR\fR
+.RS 4
+valid SSL fingerprint for the ownCloud server
+.RE
+.PP
+\fB\-\-use\-keyring\fR
+.RS 4
+use keyring if available to store password safely (Needs Python Keyring Lib to be installed)
+.RE
+.PP
+\fB\-\-dry\-run\fR
+.RS 4
+Dry Run, do not actually execute command
+.RE
+.PP
+\fB\-\-debug\fR
+.RS 4
+Print a bunch of debug info
+.RE
+.PP
+\fB\-h, \-\-help\fR
+.RS 4
+show help message and exit
+.RE
+.PP
+\fB\-v, \-\-version\fR
+.RS 4
+show program\(cqs version number and exit
+.RE
+.SH "CONFIGURATION FILE"
+.sp
+The csync configuration file can be found in \fI$HOME/\&.local/share/data/ownCloud/owncloud\&.cfg\fR\&. Only the \fBownCloud\fR section is supported\&. This file is also ued by the normal owncloud\-client\&.
+.sp
+Supported keys in the cfg file:
+.PP
+\fBuser\fR
+.RS 4
+username on the ownCloud server
+.RE
+.PP
+\fBpass\fR
+.RS 4
+password on the ownCloud server
+.RE
+.PP
+\fBurl\fR
+.RS 4
+url of the ownCloud server
+.RE
+.PP
+\fBsslfingerprint\fR
+.RS 4
+valid SSL fingerprint for the ownCloud server
+.RE
+.PP
+\fBsrc\fR
+.RS 4
+local directory to sync against
+.RE
+.PP
+\fBdst\fR
+.RS 4
+folder on the server to sync against
+.RE
+.sp
+A complete example:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+[ownCloud]
+user=awesomeSauce
+pass=PasswordThisIsSuperSuperSecretReallyISwearLOL
+url=https://www\&.example\&.org/owncloud/
+sslfingerprint=
+src=/home/awesomeSauce/ownCloud
+dst=clientsync
+.fi
+.if n \{\
+.RE
+.\}
+.SH "BUGS"
+.sp
+Please report bugs at https://github\&.com/csawyerYumaed/pyOwnCloud/issues\&.
+.SH "SEE ALSO"
+.sp
+\fBlibcsync\fR(7)
+.SH "AUTHORS"
+.sp
+pyOwnCloud Team <pyowncloud at lists\&.cknow\&.org>
+.SH "COPYING"
+.sp
+Copyright (c) 2013 pyOwnCloud Team\&. Free use of this software is granted under the terms of the GNU General Public License 2 (GPL\-2)\&.
diff --git a/doc/csync.1.txt b/doc/csync.1.txt
new file mode 100644
index 0000000..7da76e1
--- /dev/null
+++ b/doc/csync.1.txt
@@ -0,0 +1,124 @@
+csync(1)
+========
+
+NAME
+----
+
+csync - ownCloud CLI client written in python
+
+
+SYNOPSIS
+--------
+
+*csync* [-h] [-v] [-c 'CONFIG'] [-u 'USER'] [--ssl 'SSLFINGERPRINT']
+ [-p 'PASS'] [--dry-run] [--debug] [-s 'SRC'] [-d 'DST']
+ [--url 'URL'] [--use-keyring]
+
+
+DESCRIPTION
+-----------
+
+Syncing files across machines using ownCloud DAV server.
+
+.Password options:
+- You can specify on the cmd line: *-p* (not very safe)
+- In the environment variable: 'OCPASS'
+- In the owncloud.cfg file as *pass = '<password>'*
+- Use keyring to store passwords in a keyring (needs Python Keyring Lib to be installed)
+- Do none of the above, and it will prompt you for the 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).
+
+OPTIONS
+-------
+
+*-c 'CONFIG', --config 'CONFIG'*::
+ Configuration file to use
+
+*-u 'USER', --user 'USER'*::
+ Username on the ownCloud server
+*-p 'PASS', --pass 'PASS'*::
+ Password on the ownCloud server
+ ( You can also store this in environment variable 'OCPASS' )
+
+*-s 'SRC', --src 'SRC'*::
+ Local directory to sync against
+*-d 'DST', --dst 'DST'*::
+ Folder on server to sync against
+
+*--url 'URL'*::
+ URL of the ownCloud server
+*--ssl 'SSLFINGERPRINT'*::
+ valid SSL fingerprint for the ownCloud server
+
+*--use-keyring*::
+ use keyring if available to store password safely (Needs Python Keyring Lib to be installed)
+*--dry-run*::
+ Dry Run, do not actually execute command
+*--debug*::
+ Print a bunch of debug info
+*-h, --help*::
+ show help message and exit
+*-v, --version*::
+ show program's version number and exit
+
+CONFIGURATION FILE
+------------------
+
+The csync configuration file can be found in '$HOME/.local/share/data/ownCloud/owncloud.cfg'.
+Only the *ownCloud* section is supported. This file is also ued by the normal owncloud-client.
+
+Supported keys in the cfg file:
+
+*user*::
+ username on the ownCloud server
+
+*pass*::
+ password on the ownCloud server
+
+*url*::
+ url of the ownCloud server
+
+*sslfingerprint*::
+ valid SSL fingerprint for the ownCloud server
+
+*src*::
+ local directory to sync against
+
+*dst*::
+ folder on the server to sync against
+
+A complete example:
+
+ [ownCloud]
+ user=awesomeSauce
+ pass=PasswordThisIsSuperSuperSecretReallyISwearLOL
+ url=https://www.example.org/owncloud/
+ sslfingerprint=
+ src=/home/awesomeSauce/ownCloud
+ dst=clientsync
+
+BUGS
+----
+
+Please report bugs at https://github.com/csawyerYumaed/pyOwnCloud/issues.
+
+
+SEE ALSO
+--------
+
+*libcsync*(7)
+
+
+AUTHORS
+-------
+
+pyOwnCloud Team <pyowncloud at lists.cknow.org>
+
+
+COPYING
+-------
+Copyright (c) 2013 pyOwnCloud Team. Free use of this software is
+granted under the terms of the GNU General Public License 2 (GPL-2).
+
diff --git a/doc/makeman.sh b/doc/makeman.sh
new file mode 100755
index 0000000..e442352
--- /dev/null
+++ b/doc/makeman.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+# Last Change: 2008-07-03 11:08:54
+
+for f in doc/*1.txt; do
+ echo -e "\e[32mCreating manpage ${f%.*}\e[0m"
+ a2x --doctype=manpage --format=manpage $f
+ rm -f ${f%.*}.xml
+done
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/python-owncloud.git
More information about the Pkg-owncloud-commits
mailing list