Split up manual into a file per chapter

17 files changed, 103 insertions, 111 deletions

diff --git a/manual/000.mdwn b/manual/000.mdwn
new file mode 100644
index 00000000..baf0f8a6
--- /dev/null
+++ b/manual/000.mdwn
@@ -0,0 +1,3 @@
+% Backups with Obnam
+% Lars Wirzenius
+
diff --git a/manual/010-introduction.mdwn b/manual/010-introduction.mdwn
new file mode 100644
index 00000000..75238d70
--- /dev/null
+++ b/manual/010-introduction.mdwn
@@ -0,0 +1,4 @@
+Introduction
+============
+
+This is the manual for Obnam, a backup tool.
diff --git a/manual/020-concepts.mdwn b/manual/020-concepts.mdwn
new file mode 100644
index 00000000..407771bb
--- /dev/null
+++ b/manual/020-concepts.mdwn
@@ -0,0 +1,8 @@
+You know you should
+===================
+
+This chapter is philosophical and theoretical about backups.
+It discusses why you should back up, various concepts around backups,
+what kinds of things you should think about when setting up backups
+and what to do in the long term (verification, etc). It also discusses
+some assumptions Obnam makes and some constraints it imposes.
diff --git a/manual/040-installing.mdwn b/manual/040-installing.mdwn
new file mode 100644
index 00000000..335e2c31
--- /dev/null
+++ b/manual/040-installing.mdwn
@@ -0,0 +1,8 @@
+Installing Obnam
+================
+
+I really don't want to write this chapter, so I'll stick to just
+telling people using Debian or Ubuntu how to install it with the
+package manager, and how to build and install it from source. I expect
+this chapter will get patches from various distros and operating
+systems to explain their installation details.
diff --git a/manual/050-quick-tour.mdwn b/manual/050-quick-tour.mdwn
new file mode 100644
index 00000000..5be8d51d
--- /dev/null
+++ b/manual/050-quick-tour.mdwn
@@ -0,0 +1,5 @@
+A quick tour of Obnam
+=====================
+
+This chapter is an extended copy of the tutorial currently at
+liw.fi/obnam/tutorial.
diff --git a/manual/060-backing-up.mdwn b/manual/060-backing-up.mdwn
new file mode 100644
index 00000000..9c0f6507
--- /dev/null
+++ b/manual/060-backing-up.mdwn
@@ -0,0 +1,7 @@
+Backing up
+==========
+
+This chapter discusses how to set up a backup repository, and running
+your backup for the first time, plus how to do incremental backups. It
+also shows how to look at the backups you've made so you have some
+confidence the backups happened.
diff --git a/manual/070-restoring.mdwn b/manual/070-restoring.mdwn
new file mode 100644
index 00000000..0fd89167
--- /dev/null
+++ b/manual/070-restoring.mdwn
@@ -0,0 +1,6 @@
+Restoring from backups
+======================
+
+This chapter discusses how to restore data from any backup generation,
+either everything or individual files. It describes both the approach
+using just Obnam, and the approach using the FUSE filesystem.
diff --git a/manual/080-forgetting.mdwn b/manual/080-forgetting.mdwn
new file mode 100644
index 00000000..83f6c0eb
--- /dev/null
+++ b/manual/080-forgetting.mdwn
@@ -0,0 +1,6 @@
+Forgetting old backup generations
+=================================
+
+This chapter will discuss how to remove old backup generations, and
+various considerations on the aspects of what to keep and for how
+long.
diff --git a/manual/100-many-clients.mdwn b/manual/100-many-clients.mdwn
new file mode 100644
index 00000000..dfcdca32
--- /dev/null
+++ b/manual/100-many-clients.mdwn
@@ -0,0 +1,7 @@
+Sharing a repository between multiple clients
+=============================================
+
+This chapter discusses what needs to be done to share a backup
+repository between clients, and why that might be useful, and when not
+to do that.
+
diff --git a/manual/110-encryption.mdwn b/manual/110-encryption.mdwn
new file mode 100644
index 00000000..ab70a1f7
--- /dev/null
+++ b/manual/110-encryption.mdwn
@@ -0,0 +1,6 @@
+Using encryption
+================
+
+This chapter discusses how to encrypt the backup repository, and how
+to manage encryption keys.
+
diff --git a/manual/120-misc.mdwn b/manual/120-misc.mdwn
new file mode 100644
index 00000000..c0d2f6ec
--- /dev/null
+++ b/manual/120-misc.mdwn
@@ -0,0 +1,5 @@
+Other stuff
+===========
+
+This chapter discusses topics that do not warrant a chapter of their
+own, such as compressing backups.
diff --git a/manual/130-case-studies.mdwn b/manual/130-case-studies.mdwn
new file mode 100644
index 00000000..05f90bf6
--- /dev/null
+++ b/manual/130-case-studies.mdwn
@@ -0,0 +1,14 @@
+Case studies
+============
+
+This chapter goes through, in some detail, some typical use cases for
+backups. For case, it discusses the data being backed up, and explains
+choices of backup strategy, storage, etc. Some case studies:
+
+* Single laptop user, typical data of documents, photos, music,
+  backing up to a USB hard drive.
+* A VPS or similar server, with web pages, e-mail, and maybe other
+  data, backed up to another server.
+* A small company with a number of laptops and desktops, a local file
+  server, a rented co-lo server, backing up to a rented server in a
+  co-lo and to a rotated set of large USB drives.
diff --git a/manual/140-troubleshooting.mdwn b/manual/140-troubleshooting.mdwn
new file mode 100644
index 00000000..1d4b377b
--- /dev/null
+++ b/manual/140-troubleshooting.mdwn
@@ -0,0 +1,7 @@
+Troubleshooting
+===============
+
+This chapter discusses how to debug problems with Obnam. It covers
+things such as log files, various levels of logging and tracing, and
+common problems with Obnam use. It also explains what things go where
+in an Obnam backup repository.
diff --git a/manual/150-config.mdwn b/manual/150-config.mdwn
new file mode 100644
index 00000000..10878978
--- /dev/null
+++ b/manual/150-config.mdwn
@@ -0,0 +1,7 @@
+Obnam configuration files and settings
+======================================
+
+This chapter is a reference manual for all the configuration settings
+in Obnam, and what their meaning is, and what their sensible use is,
+including examples and everything. It also explains configuration file
+location and syntax, with examples.
diff --git a/manual/900-see-also.mdwn b/manual/900-see-also.mdwn
new file mode 100644
index 00000000..e9545e65
--- /dev/null
+++ b/manual/900-see-also.mdwn
@@ -0,0 +1,5 @@
+SEE ALSO
+========
+
+This chapter gives pointers to more information about obnam, backups,
+and related things.
diff --git a/manual/Makefile b/manual/Makefile
index 93788763..63b529c1 100644
--- a/manual/Makefile
+++ b/manual/Makefile
@@ -2,8 +2,11 @@ sources = $(wildcard *.mdwn)
 
 all: manual.pdf manual.html
 
-manual.pdf: $(sources)
+manual.pdf: Makefile $(sources)
 	pandoc --toc --chapters -o manual.pdf $(sources)
 
-manual.html: $(sources)
+manual.html: Makefile $(sources)
 	pandoc --toc --chapters --standalone -o manual.html $(sources)
+
+clean:
+	rm -f manual.pdf manual.html
diff --git a/manual/index.mdwn b/manual/index.mdwn
deleted file mode 100644
index 14254aaa..00000000
--- a/manual/index.mdwn
+++ /dev/null
@@ -1,109 +0,0 @@
-% Backups with Obnam
-% Lars Wirzenius
-
-Introduction
-============
-
-This is the manual for Obnam, a backup tool.
-
-You know you should
-===================
-
-This chapter is philosophical and theoretical about backups.
-It discusses why you should back up, various concepts around backups,
-what kinds of things you should think about when setting up backups
-and what to do in the long term (verification, etc). It also discusses
-some assumptions Obnam makes and some constraints it imposes.
-
-Installing Obnam
-================
-
-I really don't want to write this chapter, so I'll stick to just
-telling people using Debian or Ubuntu how to install it with the
-package manager, and how to build and install it from source. I expect
-this chapter will get patches from various distros and operating
-systems to explain their installation details.
-
-A quick tour of Obnam
-=====================
-
-This chapter is an extended copy of the tutorial currently at
-liw.fi/obnam/tutorial.
-
-Backing up
-==========
-
-This chapter discusses how to set up a backup repository, and running
-your backup for the first time, plus how to do incremental backups. It
-also shows how to look at the backups you've made so you have some
-confidence the backups happened.
-
-Restoring from backups
-======================
-
-This chapter discusses how to restore data from any backup generation,
-either everything or individual files. It describes both the approach
-using just Obnam, and the approach using the FUSE filesystem.
-
-Forgetting old backup generations
-=================================
-
-This chapter will discuss how to remove old backup generations, and
-various considerations on the aspects of what to keep and for how
-long.
-
-Obnam configuration files and settings
-======================================
-
-This chapter is a reference manual for all the configuration settings
-in Obnam, and what their meaning is, and what their sensible use is,
-including examples and everything. It also explains configuration file
-location and syntax, with examples.
-
-Sharing a repository between multiple clients
-=============================================
-
-This chapter discusses what needs to be done to share a backup
-repository between clients, and why that might be useful, and when not
-to do that.
-
-Using encryption
-================
-
-This chapter discusses how to encrypt the backup repository, and how
-to manage encryption keys.
-
-Other stuff
-===========
-
-This chapter discusses topics that do not warrant a chapter of their
-own, such as compressing backups.
-
-Case studies
-============
-
-This chapter goes through, in some detail, some typical use cases for
-backups. For case, it discusses the data being backed up, and explains
-choices of backup strategy, storage, etc. Some case studies:
-
-* Single laptop user, typical data of documents, photos, music,
-  backing up to a USB hard drive.
-* A VPS or similar server, with web pages, e-mail, and maybe other
-  data, backed up to another server.
-* A small company with a number of laptops and desktops, a local file
-  server, a rented co-lo server, backing up to a rented server in a
-  co-lo and to a rotated set of large USB drives.
-
-Troubleshooting
-===============
-
-This chapter discusses how to debug problems with Obnam. It covers
-things such as log files, various levels of logging and tracing, and
-common problems with Obnam use. It also explains what things go where
-in an Obnam backup repository.
-
-SEE ALSO
-========
-
-This chapter gives pointers to more information about obnam, backups,
-and related things.