faubackup2/documentation faubackup.xml,1.1,1.2

Update of /cvsroot/faubackup/faubackup2/documentation
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12501/documentation

Modified Files:
	faubackup.xml 
Log Message:
start manpage

Index: faubackup.xml
===================================================================
RCS file: /cvsroot/faubackup/faubackup2/documentation/faubackup.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** faubackup.xml	3 Jun 2005 09:13:19 -0000	1.1
--- faubackup.xml	8 Jun 2005 07:50:09 -0000	1.2
***************
*** 15,29 ****
  <cmdsynopsis>
    <command>faubackup</command>    
!     <sbr/>
!     <sbr/>
  </cmdsynopsis>
  </refsynopsisdiv>
  
  
! <refsect1><title>DESCRIPTION</title>
  <para>
! 	TODO
  </para>
  </refsect1>
  
  </refentry>
--- 15,95 ----
  <cmdsynopsis>
    <command>faubackup</command>    
!   <arg choice="plain">
! 	<optional><replaceable>srchost</replaceable>:</optional><replaceable>srcdir</replaceable>
!   </arg>
!   <arg choice="plain">
! 	  <optional><replaceable>desthost</replaceable>:</optional><replaceable>destdir</replaceable>
!   </arg>
  </cmdsynopsis>
  </refsynopsisdiv>
  
  
! <refsect1><title>Description</title>
  <para>
! 	<command>faubackup</command> uses a filesystem on a hard drive for
! 	incremental and full backups.  This enables the backup to be accessable
! 	through standard filesystem tools.
! </para>
! 
! <para>
! 	Later Backups to the same filesystem will automatically be incremental,
! 	as unchanged files are only hard-linked with the existing version of
! 	the file.
! </para>
! 
! <para>
! 	Executing <command>faubackup srcdir destdir</command> is a bit
! 	like <command>cp -a srcdir destdir/`date`</command>.
! 	That is, it will copy everything from <parameter>srcdir</parameter> to
! 	a subdirectory of <parameter>destdir</parameter>.  This directory is
! 	named after the time of the backup
! 	(format <filename>YYYY-MM-DD@hh:mm:ss</filename>).
! 	All filenames, permissions, and contents will be preserved.  It can
! 	cope with soft- and hardlinks and with holes in files.
! </para>
! 
! <para>
! 	The big advantage over a simple copy is the use of hardlinks between
! 	unchanged files to minimize disk space usage.  You can execute
! 	faubackup on a regular basis, and any files which haven't changed
! 	between these calls are not copied again, but are hardlinked between
! 	the various backup-directories.  This is similar to incremental
! 	backups, where only changed files are written to the tape.
! </para>
! 
! <para>
! 	If <parameter>srcdir</parameter> or <parameter>destdir</parameter>
! 	contains a colon (<token>:</token>), it is considered a remote backup.
! 	The part preceeding the colon will be the machine to backup from, the
! 	part following the colon will be the directory to backup.
! 	<command>faubackup</command> must be able to get a root shell account
! 	on the remote machine, in order to backup its files.
  </para>
  </refsect1>
  
+ <refsect1><title>Environment</title>
+ <para>
+ <variablelist>
+ <varlistentry><term>FAUBACKUP_BIN</term>
+ <listitem>The path to the <command>faubackup</command> binary.
+ This is used to execute the other part of <command>faubackup</command>
+ on a remote machine.
+ The default value is <filename>faubackup</filename>.
+ </listitem> </varlistentry>
+ 
+ <varlistentry><term>FAUBACKUP_CONF</term>
+ <listitem>The path to <filename>faubackup.conf</filename>.
+ It is used to locate the configuration file.
+ </listitem></varlistentry>
+ 
+ <varlistentry><term>FAUBACKUP_RSH</term>
+ <listitem>The path to a remote shell.
+ It is used to execute faubackup on a remote machine.
+ The default value is <filename>ssh</filename>.
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+ 
+ 
  </refentry>



-------------------------------------------------------
This SF.Net email is sponsored by: NEC IT Guy Games.  How far can you shotput
a projector? How fast can you ride your desk chair down the office luge track?
If you want to score the big prize, get to know the little guy.  
Play to win an NEC 61" plasma display: http://www.necitguy.com/?r=20