Further changes related to examples file

git-svn-id: http://svn.savannah.nongnu.org/svn/rdiff-backup/trunk@424 2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109
author: bescoto <bescoto@2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109> 2003-09-12 00:48:36 +0000
committer: bescoto <bescoto@2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109> 2003-09-12 00:48:36 +0000
commit: 153d8271ec3c3b9d7b5aacb6f01edff9e10ca13e (patch)
tree: dd92aad816f7f9698203d47f76afdbb3692200de
parent: 3d99a2ee601b0623bab33a08b23658b6697dd805 (diff)
download: rdiff-backup-153d8271ec3c3b9d7b5aacb6f01edff9e10ca13e.tar.gz
4 files changed, 38 insertions, 126 deletions
diff --git a/rdiff-backup/CHANGELOG b/rdiff-backup/CHANGELOG
index a74cf10..8189e6e 100644
--- a/rdiff-backup/CHANGELOG
+++ b/rdiff-backup/CHANGELOG
@@ -24,6 +24,9 @@ Added new time specification by backup number.  So now you can
 '--remove-older-than 2B' or '--list-at-time 0B'.  Original suggestion
 by Alan Bailward.
 
+File examples.html added to distribution; examples section removed
+from man page.
+
 
 New in v0.13.1 (2003/08/08)
 ---------------------------
diff --git a/rdiff-backup/dist/makedist b/rdiff-backup/dist/makedist
index 926b686..9f41a90 100755
--- a/rdiff-backup/dist/makedist
+++ b/rdiff-backup/dist/makedist
@@ -23,37 +23,42 @@ def CopyMan(destination, version):
 	fp.close()
 	infp.close()
 
-def MakeFAQ():
-	"""Create FAQ.html and FAQ.wml files from FAQ-body.html"""
-	faqbody_fp = open("FAQ-body.html", "r")
-	faqbody_string = faqbody_fp.read()
-	faqbody_fp.close()
+def MakeHTML(input_prefix, title):
+	"""Create html and wml versions from given html body
 
-	wml_fp = open("FAQ.wml", "w")
+	Input expected in <input_prefix>-body.html, and output will be put
+	in <input_prefix>.wml and <input_prefix>.html.
+
+	"""
+	body_fp = open("%s-body.html" % (input_prefix,), "r")
+	body_string = body_fp.read()
+	body_fp.close()
+
+	wml_fp = open("%s.wml" % (input_prefix,), "w")
 	wml_fp.write(
-"""#include 'template.wml' home=. curpage=faq title="rdiff-backup: FAQ"
+"""#include 'template.wml' home=. curpage=none title="%s"
 
 <divert body>
-<p><h2>FAQ:</h2>
+<p><h2>%s</h2>
 
-""")
-	wml_fp.write(faqbody_string)
+""" % (title, title))
+	wml_fp.write(body_string)
 	wml_fp.write("\n</divert>\n")
 	wml_fp.close()
 
-	html_fp = open("FAQ.html", "w")
+	html_fp = open("%s.html" % (input_prefix,), "w")
 	html_fp.write(
 """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
 <html>
   <head>
-    <title>rdiff-backup FAQ</title>
+    <title>%s</title>
   </head>
 
   <body>
-  <h1>rdiff-backup FAQ</h1>
-""")
-	html_fp.write(faqbody_string)
+  <h1>%s</h1>
+""" % (title, title))
+	html_fp.write(body_string)
 	html_fp.write("\n</body></html>")
 	html_fp.close()
 
@@ -92,7 +97,8 @@ def MakeTar():
 		os.system("rm -rf " + tardir)
 	except OSError: pass
 	os.mkdir(tardir)
-	for filename in ["CHANGELOG", "COPYING", "README", "FAQ.html",
+	for filename in ["CHANGELOG", "COPYING", "README",
+					 "FAQ.html", "examples.html",
 					 SourceDir + "/cmodule.c",
 					 SourceDir + "/_librsyncmodule.c",
 					 DistDir + "/setup.py"]:
@@ -134,24 +140,25 @@ def parse_cmdline(arglist):
 	"""Returns action"""
 	global Version
 	def error():
-		print "Syntax: makedist [--faq-only] [version_number]"
+		print "Syntax: makedist [--html-only] [version_number]"
 		sys.exit(1)		
 
-	optlist, args = getopt.getopt(arglist, "", ["faq-only"])
+	optlist, args = getopt.getopt(arglist, "", ["html-only"])
 	if len(args) != 1: error()
 	else: Version = args[0]
 
 	for opt, arg in optlist:
-		if opt == "--faq-only": return "FAQ"
+		if opt == "--html-only": return "HTML"
 		else: assert 0, "Bad argument"
 	return "All"
 
 def Main():
 	action = parse_cmdline(sys.argv[1:])
-	print "Making FAQ"
-	MakeFAQ()
+	print "Making HTML"
+	MakeHTML("FAQ", "rdiff-backup FAQ")
+	MakeHTML("examples", "rdiff-backup examples")
 
-	if action != "FAQ":
+	if action != "HTML":
 		assert action == "All"
 		print "Processing version " + Version
 		tarfile = MakeTar()
diff --git a/rdiff-backup/examples-body.html b/rdiff-backup/examples-body.html
index ef7f9c9..ef677ba 100644
--- a/rdiff-backup/examples-body.html
+++ b/rdiff-backup/examples-body.html
@@ -1,6 +1,4 @@
-<h2>Examples</h2>
-
-<h3>Sections:</h3>
+<h3>Sections</h3>
 
 <ul>
 <li><a href="#backup">Backing up</a></li>
diff --git a/rdiff-backup/rdiff-backup.1 b/rdiff-backup/rdiff-backup.1
index a057988..865154d 100644
--- a/rdiff-backup/rdiff-backup.1
+++ b/rdiff-backup/rdiff-backup.1
@@ -33,7 +33,7 @@ stored in a special subdirectory of that target directory, so you can
 still recover files lost some time ago.  The idea is to combine the
 best features of a mirror and an incremental backup.  rdiff-backup
 also preserves symlinks, special files, hardlinks, permissions,
-uid/gid ownership (if it is running as root), and modification times.
+uid/gid ownership, and modification times.
 
 .B rdiff-backup
 can also operate
@@ -54,6 +54,10 @@ except with rdiff-backup.  Many of the increments are stored as
 reverse diffs, so if you delete or modify a file, you may lose the
 ability to restore previous versions of that file.
 
+Finally, this man page is intended more as a precise description of
+the behavior and syntax of rdiff-backup.  New users may want to check
+out the examples.html file included in the rdiff-backup distribution.
+
 .SH OPTIONS
 .TP
 .B -b, --backup-mode
@@ -194,11 +198,6 @@ to --remove-older-than.  Specifying a subdirectory is allowable; then
 only the sizes of the mirror and increments pertaining to that
 subdirectory will be listed.
 .TP
-.B "-m, --mirror-only"
-Do not create an rdiff-backup-data directory or make any increments.
-In this mode rdiff-backup is similar to rsync (but usually
-slower).
-.TP
 .B --no-change-dir-inc-perms
 Do not change the permissions of the directory increments to match the
 directories they represent.
@@ -346,101 +345,6 @@ is noisiest).  This determines how much is written to the log file.
 .B "-V, --version"
 Print the current version and exit
 
-.SH EXAMPLES
-Simplest case---backup directory foo to directory bar, with increments
-in bar/rdiff-backup-data:
-.PP
-.RS
-rdiff-backup foo bar
-.PP
-.RE
-This is exactly the same as previous example because trailing slashes
-are ignored:
-.PP
-.RS
-rdiff-backup foo/ bar/
-.PP
-.RE
-Back files up from /home/bob to /mnt/backup, leaving increments in /mnt/backup/rdiff-backup-data.  Do not back up directory /home/bob/tmp or any files in it.
-.PP
-.RS
-rdiff-backup --exclude /home/bob/tmp /home/bob /mnt/backup
-.PP
-.RE
-The file selection options can be combined in various ways.  The
-following command backs up the whole file system to /usr/local/backup.
-However, the entire /usr directory is skipped, with the exception of
-/usr/local, which is included, except for /usr/local/backup, which is
-excluded to prevent a circularity:
-.PP
-.RS
-rdiff-backup --exclude /usr/local/backup --include /usr/local --exclude /usr / /usr/local/backup
-.PP
-.RE
-You can also use regular expressions in the --exclude statements.
-This will skip any files whose full pathnames contain the word
-"cache", or any files whose name is "tmp", "temp", "TMP", "tEmP", etc.
-.PP
-.RS
-rdiff-backup --exclude-regexp cache --exclude-regexp '(?i)/te?mp$' /home/bob /mnt/backup
-.PP
-.RE
-After the previous command was completed, this command will list the
-backups present on the destination disk:
-.PP
-.RS
-rdiff-backup --list-increments /mnt/backup
-.PP
-.RE
-If space is running out on the /mnt/backup directory, older
-incremental backups can be erased.  The following command erases
-backup information older than a week:
-.PP
-.RS
-rdiff-backup --remove-older-than 7D /mnt/backup
-.PP
-.RE
-The following reads the file
-important-data.2001-07-15T04:09:38-07:00.dir and restores the
-resulting directory important-data as it was on Februrary 14, 2001,
-calling the new directory "temp".  Note that rdiff-backup goes into
-restore mode because it recognizes the suffix of the file.  The -v9
-means keep lots of logging information.
-.PP
-.RS
-rdiff-backup -v9 important-data.2001-07-15T04:09:38-07:00.dir temp
-.PP
-.RE
-This command causes rdiff-backup to backup the directory
-/some/local-dir to the directory /whatever/remote-dir on the machine
-hostname.net.  It uses ssh to open the necessary pipe to the remote
-copy of rdiff-backup.  Here the username on the local machine and on
-hostname.net are the same.
-.PP
-.RS
-rdiff-backup /some/local-dir hostname.net::/whatever/remote-dir
-.PP
-.RE
-This command logs into hostname.net as smith and restores the remote
-increment old-file on a remote computer to the current directory on
-the local computer:
-.PP
-.RS
-rdiff-backup smith@hostname.net::/foo/rdiff-backup-data/increments/bar/old-file.2001-11-09T12:43:53-04:00.diff
-.PP
-.RE
-Backup foo on one remote machine to bar on another.  This will
-probably be slower than running rdiff-backup from either machine.
-.PP
-.RS
-rdiff-backup smith@host1::foo jones@host2::bar
-.PP
-.RE
-Test to see if the specified ssh command really opens up a working
-rdiff-backup server on the remote side.
-.RS
-rdiff-backup --test-server hostname.net::/ignored
-
 .SH RESTORING
 There are two ways to tell rdiff-backup to restore a file or
 directory.  Firstly, you can run rdiff-backup on a mirror file and use
author	bescoto <bescoto@2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109>	2003-09-12 00:48:36 +0000
committer	bescoto <bescoto@2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109>	2003-09-12 00:48:36 +0000
commit	153d8271ec3c3b9d7b5aacb6f01edff9e10ca13e (patch)
tree	dd92aad816f7f9698203d47f76afdbb3692200de
parent	3d99a2ee601b0623bab33a08b23658b6697dd805 (diff)
download	rdiff-backup-153d8271ec3c3b9d7b5aacb6f01edff9e10ca13e.tar.gz