summaryrefslogtreecommitdiff
path: root/ext2ed/ext2ed.8.in
diff options
context:
space:
mode:
authorTheodore Ts'o <tytso@mit.edu>2002-05-11 19:17:00 -0400
committerTheodore Ts'o <tytso@mit.edu>2002-05-11 19:17:00 -0400
commitb5ffeadece25f7dca04847dfc013e979fe36e3a6 (patch)
treef4c7c9313788c95e2d6019ad707eea2fc7a56905 /ext2ed/ext2ed.8.in
parent0f31c737dbf999c90a0842e6a499416b8e1f0cb4 (diff)
downloade2fsprogs-b5ffeadece25f7dca04847dfc013e979fe36e3a6.tar.gz
Integrate ext2ed into the e2fsprogs build system, and make minimal changes so
that it will compile on modern systems. The top-level makefile does not recurse into the ext2ed directory for now, pending determination of whether the original author is still maintaining ext2ed. The documentation files have been renamed to remove the version from the filename. In addition, the SGML files have been converted from LinuxDoc to DocBook. The way root_bindir, root_sbindir, and root_libdir have been changed so that if root_prefix is not set, the values set by the configure command-line options to set the directory names using --bindir, --sbindir, --libdir will affect the root_bindir, et.al Makefile variables.
Diffstat (limited to 'ext2ed/ext2ed.8.in')
-rw-r--r--ext2ed/ext2ed.8.in72
1 files changed, 72 insertions, 0 deletions
diff --git a/ext2ed/ext2ed.8.in b/ext2ed/ext2ed.8.in
new file mode 100644
index 00000000..b5d6b333
--- /dev/null
+++ b/ext2ed/ext2ed.8.in
@@ -0,0 +1,72 @@
+.\" -*- nroff -*-
+.TH EXT2ED 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
+.SH NAME
+ext2ed \- ext2 file system editor
+.SH SYNOPSIS
+.B ext2ed
+.SH DESCRIPTION
+.B ext2ed
+in an
+.B editor
+for the
+.B second extended filesystem.
+Its aim is to show you the various internal filesystem structures in an
+intuitive form so that you would be able to easily understand and modify
+them.
+.SH DOCUMENTATION
+The documentation is not available in man page format. Instead, I have
+written three articles which are related to ext2ed:
+
+The first article is
+.B The user's guide.
+This article explains how to use ext2ed.
+
+The second article is
+.B The Ext2fs overview.
+This article gives an overview of internal structure of the ext2 filesystem.
+You need to understand the internal layout in order to effectively edit
+your filesystem.
+
+The third article is
+.B EXT2ED - Design and implementation.
+This article explains how I constructed ext2ed. You may want to have a look
+in it if you plan to view or modify the source code.
+
+.SH WARNING
+
+.B
+Do not use ext2ed on a mounted filesystem.
+
+.SH FILES
+.TP
+.I /usr/bin/ext2ed
+The program itself.
+.TP
+.I @root_sysconfdir@/ext2ed.conf
+ext2ed's configuration file.
+.TP
+.I @datadir@/ext2.descriptors
+Definition of the various objects for the ext2 filesystem.
+.TP
+.I /var/log/ext2ed.log
+Log file of actual changes made to the filesystem.
+.TP
+.I /usr/man/man8/ext2ed.8
+The manual page.
+.TP
+.I @datadir@/doc/ext2ed/user-guide-0.1.ps
+The user's guide.
+.TP
+.I @datadir@/doc/ext2ed/Ext2fs-overview-0.1.ps
+Technical overview of the ext2 filesystem.
+.TP
+.I @datadir@/doc/ext2ed/ext2ed-design-0.1.ps
+EXT2ED design notes.
+
+.SH BUGS
+Filesystems bigger than 2 GB aren't yet supported.
+.SH AUTHOR
+Gadi Oxman <tgud@tochnapc2.technion.ac.il>
+.SH SEE ALSO
+.BR e2fsck (8),
+.BR debugfs (8)