]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
docs: add fsck.cramfs manual page
authorSami Kerola <kerolasa@iki.fi>
Mon, 8 Apr 2013 19:32:59 +0000 (20:32 +0100)
committerKarel Zak <kzak@redhat.com>
Tue, 9 Apr 2013 10:26:50 +0000 (12:26 +0200)
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
disk-utils/Makemodule.am
disk-utils/fsck.cramfs.8 [new file with mode: 0644]

index 70b058b3a50ec567a0507c161e2a232f56aad24c..22d066bfc875a0195fe023ab56a023e94974027b 100644 (file)
@@ -92,6 +92,7 @@ cramfs_common_sources = disk-utils/cramfs.h disk-utils/cramfs_common.c
 sbin_PROGRAMS += fsck.cramfs
 fsck_cramfs_SOURCES = disk-utils/fsck.cramfs.c $(cramfs_common_sources)
 fsck_cramfs_LDADD = $(LDADD) -lz libcommon.la
+dist_man_MANS += disk-utils/fsck.cramfs.8
 
 sbin_PROGRAMS += mkfs.cramfs
 mkfs_cramfs_SOURCES = disk-utils/mkfs.cramfs.c $(cramfs_common_sources)
diff --git a/disk-utils/fsck.cramfs.8 b/disk-utils/fsck.cramfs.8
new file mode 100644 (file)
index 0000000..5519cbc
--- /dev/null
@@ -0,0 +1,57 @@
+.TH EXAMPLE "8" "April 2013" "util-linux" "System Administration"
+.SH NAME
+fsck.cramfs \- fsck compressed ROM file system
+.SH SYNOPSIS
+.B mkfs.cramfs
+[options]
+.I file
+.SH DESCRIPTION
+.I mkfs.cramfs
+is used to check the cramfs file system.
+.SH OPTIONS
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Enable verbose messaging.
+.TP
+\fB\-x\fR, \fB\-\-destination\fR [\fIdirectory\fR]
+Extract contents of the
+.I file
+to
+.IR directory .
+.TP
+\fB\-a\fR
+This option is silently ignored.
+.TP
+\fB\-y\fR
+This option is silently ignored.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Display version information and exit.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display help and exit.
+.SH "EXIT STATUS"
+.RS
+.PD 0
+.TP
+.B 0
+success
+.TP
+.B 4
+file system was left uncorrected
+.TP
+.B 8
+operation error, such as unable to allocate memory
+.TP
+.B 16
+usage information was printed
+.PD
+.RE
+.SH "SEE ALSO"
+.BR mount (8),
+.BR fsck.cramfs (8)
+.SH AVAILABILITY
+The example command is part of the util-linux package and is available from
+.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+Linux Kernel Archive
+.UE .