diff --git a/doc/ocsync.1 b/doc/ocsync.1 index 9d2f7e16a1..ce10b7ed63 100644 --- a/doc/ocsync.1 +++ b/doc/ocsync.1 @@ -1,161 +1,22 @@ -.\" Title: csync +'\" t +.\" Title: ocsync .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.74.0 -.\" Date: 12/13/2008 -.\" Manual: [FIXME: manual] -.\" Source: [FIXME: source] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 12/22/2012 +.\" Manual: \ \& +.\" Source: \ \& .\" Language: English .\" -.TH "CSYNC" "1" "12/13/2008" "[FIXME: source]" "[FIXME: manual]" +.TH "OCSYNC" "1" "12/22/2012" "\ \&" "\ \&" .\" ----------------------------------------------------------------- -.\" * (re)Define some macros +.\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de toupper -.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ -\\$* -.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH-xref - format a cross-reference to an SH section -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de SH-xref -.ie n \{\ -.\} -.toupper \\$* -.el \{\ -\\$* -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SH - level-one heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SH -.\" put an extra blank line of space above the head in non-TTY output -.if t \{\ -.sp 1 -.\} -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[an-margin]u -.ti 0 -.HTML-TAG ".NH \\n[an-level]" -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -\." make the size of the head bigger -.ps +3 -.ft B -.ne (2v + 1u) -.ie n \{\ -.\" if n (TTY output), use uppercase -.toupper \\$* -.\} -.el \{\ -.nr an-break-flag 0 -.\" if not n (not TTY), use normal case (not uppercase) -\\$1 -.in \\n[an-margin]u -.ti 0 -.\" if not n (not TTY), put a border/line under subheading -.sp -.6 -\l'\n(.lu' -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" SS - level-two heading that works better for non-TTY output -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de1 SS -.sp \\n[PD]u -.nr an-level 1 -.set-an-margin -.nr an-prevailing-indent \\n[IN] -.fi -.in \\n[IN]u -.ti \\n[SN]u -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.ps \\n[PS-SS]u -\." make the size of the head bigger -.ps +2 -.ft B -.ne (2v + 1u) -.if \\n[.$] \&\\$* -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BB/BE - put background/screen (filled box) around block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BB -.if t \{\ -.sp -.5 -.br -.in +2n -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EB -.if t \{\ -.if "\\$2"adjust-for-leading-newline" \{\ -.sp -1 -.\} -.br -.di -.in -.ll -.gcolor -.nr BW \\n(.lu-\\n(.i -.nr BH \\n(dn+.5v -.ne \\n(BHu+.5v -.ie "\\$2"adjust-for-leading-newline" \{\ -\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.el \{\ -\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] -.\} -.in 0 -.sp -.5v -.nf -.BX -.in -.sp .5v -.fi -.\} -.. -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" BM/EM - put colored marker in margin next to block of text -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.de BM -.if t \{\ -.br -.ll -2n -.gcolor red -.di BX -.\} -.. -.de EM -.if t \{\ -.br -.di -.ll -.gcolor -.nr BH \\n(dn -.ne \\n(BHu -\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] -.in 0 -.nf -.BX -.in -.fi -.\} -.. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,16 +27,16 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" -csync \- A commandline frontent for csync a user level bidirectional file synchronizer\&. -.SH "Synopsis" +.SH "NAME" +ocsync \- A commandline frontent for csync a user level bidirectional file synchronizer\&. +.SH "SYNOPSIS" .sp -\fBcsync\fR [\fIOPTION\fR\&...] \fISOURCE\fR \fIDESTINATION\fR +\fBocsync\fR [\fIOPTION\fR\&...] \fISOURCE\fR \fIDESTINATION\fR .SH "DESCRIPTION" .sp -csync is a client only bidirectional file synchronizer\&. It synchronizes the content of \fISOURCE\fR with \fIDESTINATION\fR and vice versa\&. The \fIDESTINATION\fR can be a local directory or a remote file server\&. +ocsync is a client only bidirectional file synchronizer\&. It synchronizes the content of \fISOURCE\fR with \fIDESTINATION\fR and vice versa\&. The \fIDESTINATION\fR can be a local directory or a remote file server\&. .sp -You can use csync for different things\&. The intention is to provide Roaming Home Directories for Linux but you can use it to synchronize your music collection or create a backup of a directory\&. +You can use ocsync for different things\&. The intention is to provide Roaming Home Directories for Linux but you can use it to synchronize your music collection or create a backup of a directory\&. .SH "OPTIONS" .PP \fB\-\-create\-statedb\fR @@ -233,20 +94,14 @@ Failure (syntax or usage error; configuration error; unexpected error)\&. .sp -1 .IP \(bu 2.3 .\} -csync /home/user /backup/home/user +ocsync /home/user /backup/home/user .sp .if n \{\ .RS 4 .\} -.fam C -.ps -1 .nf -.BB lightgray Synchronizer two local directories\&. -.EB lightgray .fi -.fam -.ps +1 .if n \{\ .RE .\} @@ -260,20 +115,14 @@ Synchronizer two local directories\&. .sp -1 .IP \(bu 2.3 .\} -csync /home/user smb://server/share/user +ocsync /home/user smb://server/share/user .sp .if n \{\ .RS 4 .\} -.fam C -.ps -1 .nf -.BB lightgray Synchronize a home directory with a SMB share\&. -.EB lightgray .fi -.fam -.ps +1 .if n \{\ .RE .\} @@ -287,21 +136,15 @@ Synchronize a home directory with a SMB share\&. .sp -1 .IP \(bu 2.3 .\} -csync /home/user smb://user:password@server/share/user +ocsync /home/user smb://user:password@server/share/user .sp .if n \{\ .RS 4 .\} -.fam C -.ps -1 .nf -.BB lightgray Synchronize a home directory with a SMB share and provide username and password directly\&. -.EB lightgray .fi -.fam -.ps +1 .if n \{\ .RE .\} @@ -311,10 +154,30 @@ password directly\&. Please report bugs at https://dev\&.csync\&.org/\&. .SH "SEE ALSO" .sp -\fBlibcsync\fR(7) +\fBlibocsync\fR(7) .SH "AUTHORS" .sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} Andreas Schneider +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Klaas Freitag +.RE .SH "COPYING" .sp Copyright \e(c) 2006\-2008 Andreas Schneider\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. diff --git a/doc/ocsync.1.txt b/doc/ocsync.1.txt index a00dc842c1..9364d46660 100644 --- a/doc/ocsync.1.txt +++ b/doc/ocsync.1.txt @@ -1,27 +1,27 @@ -csync(1) +ocsync(1) ======== NAME ---- -csync - A commandline frontent for csync a user level bidirectional file +ocsync - A commandline frontent for csync a user level bidirectional file synchronizer. SYNOPSIS -------- -*csync* ['OPTION'...] 'SOURCE' 'DESTINATION' +*ocsync* ['OPTION'...] 'SOURCE' 'DESTINATION' DESCRIPTION ----------- -csync is a client only bidirectional file synchronizer. It synchronizes the +ocsync is a client only bidirectional file synchronizer. It synchronizes the content of 'SOURCE' with 'DESTINATION' and vice versa. The 'DESTINATION' can be a local directory or a remote file server. -You can use csync for different things. The intention is to provide Roaming +You can use ocsync for different things. The intention is to provide Roaming Home Directories for Linux but you can use it to synchronize your music collection or create a backup of a directory. @@ -66,15 +66,15 @@ EXIT STATUS EXAMPLES -------- -* csync /home/user /backup/home/user +* ocsync /home/user /backup/home/user Synchronizer two local directories. -* csync /home/user smb://server/share/user +* ocsync /home/user smb://server/share/user Synchronize a home directory with a SMB share. -* csync /home/user smb://user:password@server/share/user +* ocsync /home/user smb://user:password@server/share/user Synchronize a home directory with a SMB share and provide username and password directly. @@ -88,14 +88,14 @@ Please report bugs at https://dev.csync.org/. SEE ALSO -------- -*libcsync*(7) +*libocsync*(7) AUTHORS ------- -Andreas Schneider - +* Andreas Schneider +* Klaas Freitag COPYING -------