From db85bed00084b84d7178d5277e6d67d86c2e119f Mon Sep 17 00:00:00 2001
From: szaka <szaka>
Date: Sun, 20 Jan 2008 16:31:10 +0000
Subject: [PATCH] add ntfs-3g.probe manual

---
 configure.ac           |  1 +
 src/Makefile.am        |  2 +-
 src/ntfs-3g.probe.8.in | 81 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 83 insertions(+), 1 deletion(-)
 create mode 100644 src/ntfs-3g.probe.8.in

diff --git a/configure.ac b/configure.ac
index 9bc832ae..b0c2e027 100644
--- a/configure.ac
+++ b/configure.ac
@@ -336,6 +336,7 @@ AC_CONFIG_FILES([
 	libntfs-3g/libntfs-3g.script.so
 	src/Makefile
 	src/ntfs-3g.8
+	src/ntfs-3g.probe.8
 ])
 AC_OUTPUT
 
diff --git a/src/Makefile.am b/src/Makefile.am
index fc74bbdf..af22dadc 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -12,7 +12,7 @@ endif
 bin_PROGRAMS	 = ntfs-3g.probe
 rootbin_PROGRAMS = ntfs-3g
 rootsbin_DATA 	 = #Create directory
-man_MANS	 = ntfs-3g.8
+man_MANS	 = ntfs-3g.8 ntfs-3g.probe.8
 
 ntfs_3g_LDADD    = $(FUSE_LIBS) $(top_builddir)/libntfs-3g/libntfs-3g.la
 if REALLYSTATIC
diff --git a/src/ntfs-3g.probe.8.in b/src/ntfs-3g.probe.8.in
new file mode 100644
index 00000000..3e8a2678
--- /dev/null
+++ b/src/ntfs-3g.probe.8.in
@@ -0,0 +1,81 @@
+.\" Copyright (c) 2008 Szabolcs Szakacsits.
+.\" This file may be copied under the terms of the GNU Public License.
+.\"
+.TH NTFS-3G.PROBE 8 "January 2008" "ntfs-3g.probe @VERSION@"
+.SH NAME
+ntfs-3g.probe \- Probe an NTFS volume mountability
+.SH SYNOPSIS
+.B ntfs-3g.probe
+.I <\-\-readonly|\-\-readwrite>
+.I volume 
+.br
+.SH DESCRIPTION
+The \fBntfs-3g.probe\fR utility tests a volume if it's NTFS mountable 
+read-only or read-write, and exits with a status value accordingly. 
+The \fIvolume\fR can be a block device or image file.
+.SH OPTIONS
+Below is a summary of the options that \fBntfs-3g.probe\fR accepts.
+.TP
+.B \-r, \-\-readonly
+Test if the volume can be mounted read-only.
+.TP
+.B \-w, \-\-readwrite
+Test if the volume can be mounted read-write.
+.TP
+.B \-h, \-\-help
+Display help and exit.
+.SH EXAMPLE
+Test if /dev/sda1 can be mounted read-write:
+.RS
+.sp
+.B ntfs-3g.probe --readwrite /dev/sda1
+.sp
+.RE
+.SH EXIT CODES
+The exit codes are as follows:
+.IP 0
+Volume is mountable.
+.IP 11
+Syntax error, command line parsing failed.
+.IP 12
+The volume doesn't have a valid NTFS.
+.IP 13
+Inconsistent NTFS, hardware or device driver fault, or unsetup 
+SoftRAID/FakeRAID hardware. 
+.IP 14
+The NTFS partition is hibernated.
+.IP 15
+The volume was not cleanly unmounted. 
+.IP 16
+The volume is already exclusively opened and in use by a kernel
+driver or software.
+.IP 17
+Unsetup SoftRAID/FakeRAID hardware.
+.IP 18
+Unknown reason.
+.IP 19
+Not enough privilege to mount.
+.IP 20
+Out of memory.
+.IP 21
+Unclassified FUSE error.
+.SH KNOWN ISSUES
+Please see 
+.RS
+.sp
+http://ntfs-3g.org/support.html
+.sp
+.RE
+for common questions and known issues.
+If you think you have found an undocumented problem in the latest release of
+the software then please send an email describing it in detail. 
+You can contact the development team on the ntfs\-3g\-devel@lists.sf.net
+address.
+.SH AUTHORS
+.B ntfs-3g.probe 
+was written by Szabolcs Szakacsits (szaka@ntfs-3g.org). 
+.SH THANKS
+Alon Bar-Lev has integrated the utility into the NTFS-3G build process and 
+tested it with Erik Larsson before the public release.
+.SH SEE ALSO
+.BR ntfs-3g (8)