blob: edff7fdb6a4335f97801d9d594237ba26343b4d4
| 1 | .\" Copyright (c) 2008 Szabolcs Szakacsits. |
| 2 | .\" This file may be copied under the terms of the GNU Public License. |
| 3 | .\" |
| 4 | .TH NTFS-3G.PROBE 8 "January 2008" "ntfs-3g.probe 2014.2.15" |
| 5 | .SH NAME |
| 6 | ntfs-3g.probe \- Probe an NTFS volume mountability |
| 7 | .SH SYNOPSIS |
| 8 | .B ntfs-3g.probe |
| 9 | .I <\-\-readonly|\-\-readwrite> |
| 10 | .I volume |
| 11 | .br |
| 12 | .SH DESCRIPTION |
| 13 | The \fBntfs-3g.probe\fR utility tests a volume if it's NTFS mountable |
| 14 | read-only or read-write, and exits with a status value accordingly. |
| 15 | The \fIvolume\fR can be a block device or image file. |
| 16 | .SH OPTIONS |
| 17 | Below is a summary of the options that \fBntfs-3g.probe\fR accepts. |
| 18 | .TP |
| 19 | .B \-r, \-\-readonly |
| 20 | Test if the volume can be mounted read-only. |
| 21 | .TP |
| 22 | .B \-w, \-\-readwrite |
| 23 | Test if the volume can be mounted read-write. |
| 24 | .TP |
| 25 | .B \-h, \-\-help |
| 26 | Display help and exit. |
| 27 | .SH EXAMPLE |
| 28 | Test if /dev/sda1 can be mounted read-write: |
| 29 | .RS |
| 30 | .sp |
| 31 | .B ntfs-3g.probe --readwrite /dev/sda1 |
| 32 | .sp |
| 33 | .RE |
| 34 | .SH EXIT CODES |
| 35 | The exit codes are as follows: |
| 36 | .IP 0 |
| 37 | Volume is mountable. |
| 38 | .IP 11 |
| 39 | Syntax error, command line parsing failed. |
| 40 | .IP 12 |
| 41 | The volume doesn't have a valid NTFS. |
| 42 | .IP 13 |
| 43 | Inconsistent NTFS, hardware or device driver fault, or unsetup |
| 44 | SoftRAID/FakeRAID hardware. |
| 45 | .IP 14 |
| 46 | The NTFS partition is hibernated. |
| 47 | .IP 15 |
| 48 | The volume was not cleanly unmounted. |
| 49 | .IP 16 |
| 50 | The volume is already exclusively opened and in use by a kernel |
| 51 | driver or software. |
| 52 | .IP 17 |
| 53 | Unsetup SoftRAID/FakeRAID hardware. |
| 54 | .IP 18 |
| 55 | Unknown reason. |
| 56 | .IP 19 |
| 57 | Not enough privilege to mount. |
| 58 | .IP 20 |
| 59 | Out of memory. |
| 60 | .IP 21 |
| 61 | Unclassified FUSE error. |
| 62 | .SH KNOWN ISSUES |
| 63 | Please see |
| 64 | .RS |
| 65 | .sp |
| 66 | http://tuxera.com/community/ntfs-3g-faq/ |
| 67 | .sp |
| 68 | .RE |
| 69 | for common questions and known issues. |
| 70 | If you think you have found an undocumented problem in the latest release of |
| 71 | the software then please send an email describing it in detail. |
| 72 | You can contact the development team on the ntfs\-3g\-devel@lists.sf.net |
| 73 | address. |
| 74 | .SH AUTHORS |
| 75 | .B ntfs-3g.probe |
| 76 | was written by Szabolcs Szakacsits. |
| 77 | .SH THANKS |
| 78 | Alon Bar-Lev has integrated the utility into the NTFS-3G build process and |
| 79 | tested it with Erik Larsson before the public release. |
| 80 | .SH SEE ALSO |
| 81 | .BR ntfs-3g (8) |
| 82 |