Add man pages (courtesy of Lucas Wall at Debian)

9 files changed, 393 insertions, 0 deletions

diff --git a/Makefile.am b/Makefile.am
index 037d501..b897d25 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -21,6 +21,8 @@ e2cp_SOURCES = \
 	write.c write.h
 
 EXTRA_DIST = README TODO e2tools.spec
+dist_man_MANS = e2tools.7
+dist_man_MANS += e2cp.1 e2ln.1 e2ls.1 e2mkdir.1 e2mv.1 e2rm.1 e2tail.1
 
 install-exec-hook:
 	$(LN_S) -f e2cp $(DESTDIR)$(bindir)/e2ln
diff --git a/e2cp.1 b/e2cp.1
new file mode 100644
index 0000000..1842c9c
--- /dev/null
+++ b/e2cp.1
@@ -0,0 +1,61 @@
+.TH E2CP 1 "March 2, 2005"
+.\"
+.SH NAME
+e2cp \- copies files from/to an e2fs filesystem
+.\"
+.SH SYNOPSIS
+.B e2cp
+.RI [ options ] " files... dest"
+.\"
+.SH DESCRIPTION
+The \fBe2cp\fP command copies files to/from an e2fs filesystem from/to the
+machine's filesystem.
+.\"
+.SH OPTIONS
+A single `-' (dash) can be used instead of a file name to indicate standard
+input/output.
+.TP
+.B \-0
+Input lines terminated by a null character.
+.TP
+.B \-a
+Absolute directory names - create directories instead of just copying
+into the destination. Only valid for copying into an ext2fs filesystem.
+.TP
+.B \-d \fIdest_dir\fP
+Destination of files to be copied. May be in the ext2fs filesystem or
+the host filesystem.
+.TP
+.B \-G \fIgid\fP
+Set the default group to gid.
+.TP
+.B \-O \fIuid\fP
+Set the default file owner to uid.
+.TP
+.B \-p
+Preserve host file attributes (permissions, times, etc.) when copying
+files.
+.TP
+.B \-P \fImode\fP
+Set the file permissions (ie 755, 666).
+.TP
+.B \-s \fIsrc_dir\fP
+The source of the files to be copied.
+.TP
+.B \-v
+Be verbose.
+.\"
+.SH SEE ALSO
+.BR e2tools (7),
+.BR e2ln (1),
+.BR e2ls (1),
+.BR e2mkdir (1),
+.BR e2mv (1),
+.BR e2rm (1),
+.BR e2tail (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).
diff --git a/e2ln.1 b/e2ln.1
new file mode 100644
index 0000000..8755c7c
--- /dev/null
+++ b/e2ln.1
@@ -0,0 +1,39 @@
+.TH E2LN 1 "March 2, 2005"
+.\"
+.SH NAME
+e2ln \- create hard links on an ext2 filesystem
+.\"
+.SH SYNOPSIS
+.B e2ln
+.RI [ options ] " source destination"
+.\"
+.SH DESCRIPTION
+The \fBe2ln\fP command is used to create hard links on an ext2 filesystem.
+.\"
+.SH OPTIONS
+.TP
+.B \-f
+Force the operation to remove any existing files.
+.TP
+.B \-s
+Create a symlink.
+.TP
+.B \-v
+Be verbose.
+.PP
+Note: creating symlinks is not operational at this time.
+.\"
+.SH SEE ALSO
+.BR e2tools (7),
+.BR e2mv (1),
+.BR e2ls (1),
+.BR e2mkdir (1),
+.BR e2cp (1),
+.BR e2rm (1),
+.BR e2tail (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).
diff --git a/e2ls.1 b/e2ls.1
new file mode 100644
index 0000000..cc763f9
--- /dev/null
+++ b/e2ls.1
@@ -0,0 +1,59 @@
+.TH E2LS 1 "March 2, 2005"
+.\"
+.SH NAME
+e2ls \- list files and directories on an ext2 filesystem
+.\"
+.SH SYNOPSIS
+.B e2ls
+.RI [ options ] " file_specification"
+.\"
+.SH DESCRIPTION
+The \fBe2ls\fP command is used to list files and directories on an ext2
+filesystem.
+.PP
+Note: Files deleted via e2rm sometimes will show up even without the -D
+option. It is being investigated.
+.\"
+.SH OPTIONS
+.TP
+.B \-a
+Show hidden directories.
+.TP
+.B \-c
+Sort by creation time (must include -t when using -l).
+.TP
+.B \-d \fIdir\fP
+Open the ext2 filesystem specified by dir.
+.TP
+.B \-D
+Show deleted files bracketed with ><.
+.TP
+.B \-f
+No sorting of the file list.
+.TP
+.B \-i
+Show the inodes (very useful for the -l option).
+.TP
+.B \-l
+Long listing.
+.TP
+.B \-r
+Reverse the sort order.
+.TP
+.B \-t
+Sort by time.
+.\"
+.SH SEE ALSO
+.BR e2tools (7),
+.BR e2ln (1),
+.BR e2mv (1),
+.BR e2mkdir (1),
+.BR e2cp (1),
+.BR e2rm (1),
+.BR e2tail (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).
diff --git a/e2mkdir.1 b/e2mkdir.1
new file mode 100644
index 0000000..1c230ec
--- /dev/null
+++ b/e2mkdir.1
@@ -0,0 +1,41 @@
+.TH E2MKDIR 1 "March 2, 2005"
+.\"
+.SH NAME
+e2mkdir \- creates a directory on an ext2 filesystem
+.\"
+.SH SYNOPSIS
+.B e2mkdir
+.RI [ options ] " directory..."
+.\"
+.SH DESCRIPTION
+The \fBe2mkdir\fP command creates directories on an ext2 filesystem. It
+behaves similar to `mkdir -p'.
+.\"
+.SH OPTIONS
+.TP
+.B \-G \fIgid\fP
+Set the default group to gid.
+.TP
+.B \-O \fIuid\fP
+Set the default file owner to uid.
+.TP
+.B \-P \fImode\fP
+Set the file permissions (ie 755, 666).
+.TP
+.B \-v
+Be verbose.
+.\"
+.SH SEE ALSO
+.BR e2tools (7),
+.BR e2ln (1),
+.BR e2ls (1),
+.BR e2mv (1),
+.BR e2cp (1),
+.BR e2rm (1),
+.BR e2tail (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).
diff --git a/e2mv.1 b/e2mv.1
new file mode 100644
index 0000000..6042266
--- /dev/null
+++ b/e2mv.1
@@ -0,0 +1,39 @@
+.TH E2MV 1 "March 2, 2005"
+.\"
+.SH NAME
+e2mv \- moves or renames files on an ext2fs filesystem
+.\"
+.SH SYNOPSIS
+.B e2mv
+.RI [ options ] " files... dest"
+.\"
+.SH DESCRIPTION
+The \fBe2mv\fP command moves or renames files on an ext2fs filesystem. The
+source files must be explicitly stated. It does not use regular expressions,
+yet.
+.\"
+.SH OPTIONS
+.TP
+.B \-f
+Force the operation to remove any existing files.
+.TP
+.B \-s
+Swap names of the two files.
+.TP
+.B \-v
+Be verbose.
+.\"
+.SH SEE ALSO
+.BR e2tools (7),
+.BR e2ln (1),
+.BR e2ls (1),
+.BR e2mkdir (1),
+.BR e2cp (1),
+.BR e2rm (1),
+.BR e2tail (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).
diff --git a/e2rm.1 b/e2rm.1
new file mode 100644
index 0000000..1a64172
--- /dev/null
+++ b/e2rm.1
@@ -0,0 +1,34 @@
+.TH E2RM 1 "March 2, 2005"
+.\"
+.SH NAME
+e2rm \- removes files and directories on an ext2 filesystem
+.\"
+.SH SYNOPSIS
+.B e2rm
+.RI [ options ] " files..."
+.\"
+.SH DESCRIPTION
+The \fBe2rm\fP command removes files and directories on an ext2 filesystem.
+.\"
+.SH OPTIONS
+.TP
+.B \-r
+Recursively delete files if a directory name is given.
+.TP
+.B \-v
+Be verbose.
+.\"
+.SH SEE ALSO
+.BR e2tools (7),
+.BR e2ln (1),
+.BR e2ls (1),
+.BR e2mkdir (1),
+.BR e2cp (1),
+.BR e2mv (1),
+.BR e2tail (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).
diff --git a/e2tail.1 b/e2tail.1
new file mode 100644
index 0000000..bd48600
--- /dev/null
+++ b/e2tail.1
@@ -0,0 +1,46 @@
+.TH E2TAIL 1 "March 2, 2005"
+.\"
+.SH NAME
+e2tail \- a basic version of the tail command for an ext2 filesystem
+.\"
+.SH SYNOPSIS
+.B e2tail
+.RI [ options ] " file"
+.\"
+.SH DESCRIPTION
+The \fBe2tail\fP command implements a basic version of the tail command.
+.\"
+.SH OPTIONS
+.TP
+.B \-n \fInum_lines\fP
+The number of lines to display
+.TP
+.B \-f
+Output appended data as the file grows.  This is inode dependent, so if the
+file is renamed, it will keep checking it.
+.TP
+.B \-F
+Output appended data as the file grows.  This is file name dependent, so if
+the file is renamed, it will check on any new files with the same name as the
+original.  This is useful for watching log files that may be rotated out
+occasionally.  This was requested by a person in the computer security field
+for monitoring 'honeypot' type machines.
+.TP
+.B \-s \fIsleep_interval\fP
+The number of seconds to sleep before checking if the file has grown while
+in 'follow' mode.  The default is 1.
+.\"
+.SH SEE ALSO
+.BR e2tools (7),
+.BR e2ln (1),
+.BR e2ls (1),
+.BR e2mkdir (1),
+.BR e2cp (1),
+.BR e2rm (1),
+.BR e2mv (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).
diff --git a/e2tools.7 b/e2tools.7
new file mode 100644
index 0000000..c4bb9f5
--- /dev/null
+++ b/e2tools.7
@@ -0,0 +1,72 @@
+.TH E2TOOLS 7 "March 2, 2005"
+.\"
+.SH NAME
+e2tools \-  utilities to manipulate files in an ext2/ext3 filesystem
+.\"
+.SH DESCRIPTION
+E2tools is a simple set of GPL'ed utilities to read, write, and
+manipulate files in an ext2/ext3 filesystem. These utilities access a
+filesystem directly using the ext2fs library. I wrote these tools in order
+to copy files into a linux filesystem on a machine that does not have ext2
+support. Of course, they can also be used on a linux machine to read/write
+to disk images or floppies without having to mount them or have root
+access.
+.PP
+Supported functionality:
+.TP
+.B e2cp
+copy files
+.TP
+.B e2mv
+move files
+.TP
+.B e2rm
+remove files
+.TP
+.B e2mkdir
+create directory
+.TP
+.B e2ln
+create hard links
+.TP
+.B e2ls
+list files/directories
+.TP
+.B e2tail
+output the last part of a file
+.PP
+In general, to specify a directory or file on an ext2 filesystem for the
+e2tools utilities, use the following form:
+.IP
+filesystem:directory_path
+.PP
+The filesystem can be an unmounted partition or a regular file that's been
+formatted to contain an ext2 filesystem.  In general, if a command takes
+multiple file names on the command line, if the first one contains an ext2
+file specification, the rest of the files are assumed to be on the same
+filesystem until another one is explicitly stated:
+.IP
+/tmp/boot.img:/tmp/file1
+.IP
+/tmp/file2
+.IP
+/tmp/file3
+.IP
+/tmp/boot2.img:/tmp/file4
+.PP
+Files 1-3 are on /tmp/boot.img and the last file is on /tmp/boot2.img
+.\"
+.SH SEE ALSO
+.BR e2cp (1),
+.BR e2ln (1),
+.BR e2ls (1),
+.BR e2mkdir (1),
+.BR e2mv (1),
+.BR e2rm (1),
+.BR e2tail (1).
+.\"
+.SH AUTHOR
+The \fBe2tools\fP were written by Keith Sheffield <sheff@pobox.com>.
+.PP
+This manual page was written by Lucas Wall <lwall@debian.org>,
+for the Debian project (but may be used by others).