Document cryptsetup exit codes.

git-svn-id: https://cryptsetup.googlecode.com/svn/trunk@487 36d66b0a-2a48-0410-832c-cd162a569da5

diff --git a/ChangeLog b/ChangeLog
index d6ebf9b..55ba702 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,7 @@
 2011-04-22  Milan Broz  <mbroz@redhat.com>
        * Also support --skip option for loopaesOpen.
        * Fix return code when passphrase is read from pipe.
+       * Document cryptsetup exit codes.
 
 2011-04-18  Milan Broz  <mbroz@redhat.com>
        * Respect maximum keyfile size paramater.

diff --git a/man/cryptsetup.8 b/man/cryptsetup.8
index e71c483..0196849 100644 (file)
--- a/man/cryptsetup.8
+++ b/man/cryptsetup.8
@@ -354,6 +354,12 @@ The UUID must be provided in standard UUID format
 .TP
 .B "\-\-version"
 Show the version.
+.SH RETURN CODES
+Crypsetup returns 0 on success or non-zero on error.
+
+Error codes are: 1 wrong parameters, 2 no permission (bad passphrase),
+3 out of memory, 4 wrong device specified, 5 device already exists
+or device is busy.
 .SH NOTES ON PASSWORD PROCESSING FOR PLAIN MODE
 \fBFrom a terminal\fR: Password processing is new-line sensitive,
 meaning the reading will stop after encountering \\n.