|
|
1.1 root 1: .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35. 1.1.1.2 ! root 2: .TH TRUECRYPT "1" "November 2005" "truecrypt 4.1" "User Commands" 1.1 root 3: .SH NAME 4: truecrypt - manage TrueCrypt volumes 5: .SH SYNOPSIS 6: .B truecrypt 7: [\fIOPTIONS\fR] \fIVOLUME_PATH \fR[\fIMOUNT_DIRECTORY\fR] 8: .br 9: .B truecrypt 10: [\fIOPTIONS\fR] \fI-d | --dismount | -l | --list \fR[\fIMAPPED_VOLUME\fR] 11: .br 12: .B truecrypt 13: \fI-h | --help | --test | -V | --version\fR 14: .SH DESCRIPTION 15: Manages encrypted TrueCrypt volumes, which can be mapped as virtual block 16: devices and used as any other standard block device. All data being read 17: from a mapped TrueCrypt volume is transparently decrypted and all data being 18: written to it is transparently encrypted. 19: .SH OPTIONS 20: 21: VOLUME_PATH [MOUNT_DIRECTORY] 22: .IP 23: Open a TrueCrypt volume specified by VOLUME_PATH and map it as a block device 24: /dev/mapper/truecryptN. N is the first available device number if not 25: otherwise specified with \fB\-\-device\-number\fR. The filesystem of the mapped volume 26: is mounted at MOUNT_DIRECTORY if specified. 27: .PP 28: \fB\-d\fR, \fB\-\-dismount\fR [MAPPED_VOLUME] 29: .IP 30: Dismount and unmap mapped volumes. If MAPPED_VOLUME is not specified, all 31: volumes are dismounted and unmapped. See below for a description of 32: MAPPED_VOLUME. 33: .PP 34: \fB\-l\fR, \fB\-\-list\fR [MAPPED_VOLUME] 35: .IP 36: Display a list of mapped volumes. If MAPPED_VOLUME is not specified, all 37: volumes are listed. By default, the list contains only volume path and mapped 38: device name pairs. A more detailed list can be enabled by verbose output 39: option (\fB\-v\fR). See below for a description of MAPPED_VOLUME. 40: .PP 41: MAPPED_VOLUME 42: .IP 43: Specifies a mapped or mounted volume. One of the following forms can be used: 44: .IP 45: 1) Path to the encrypted TrueCrypt volume. 46: .IP 47: 2) Mount directory of the volume's filesystem (if mounted). 48: .IP 49: 3) Device number of the mapped volume. 50: .IP 51: 4) Device name of the mapped volume. 52: .PP 53: \fB\-\-device\-number\fR N 54: .IP 55: Use device number N when mapping a volume as a block device 56: /dev/mapper/truecryptN. Default is the first available device. 57: .PP 58: \fB\-\-display\-password\fR 59: .IP 60: Display password characters while typing. 61: .PP 62: \fB\-\-filesystem\fR TYPE 63: .IP 64: Filesystem type to mount. The TYPE argument is passed to mount(8) command 65: with option \fB\-t\fR. Default type is 'auto'. 66: .PP 67: \fB\-h\fR, \fB\-\-help\fR 68: .IP 69: Display help information. 70: .PP 71: \fB\-k\fR, \fB\-\-keyfile\fR FILE | DIRECTORY 72: .IP 73: Use specified keyfile to open a volume to be mapped. When a directory is 74: specified, all files inside it will be used (non\-recursively). Additional 75: keyfiles can be specified with multiple \fB\-k\fR options. See also option \fB\-K\fR. 76: .PP 77: \fB\-K\fR, \fB\-\-keyfile\-protected\fR FILE | DIRECTORY 78: .IP 79: Use specified keyfile to open a hidden volume to be protected. See also 80: options \fB\-k\fR and \fB\-P\fR. 81: .PP 82: \fB\-\-mount\-options\fR OPTIONS 83: .IP 84: Filesystem mount options. The OPTIONS argument is passed to mount(8) 85: command with option \fB\-o\fR. 86: .PP 87: \fB\-p\fR, \fB\-\-password\fR PASSWORD 88: .IP 89: Use specified password to open a volume. Additional passwords can be 90: specified with multiple \fB\-p\fR options. An empty password can also be specified 91: ("" in most shells). Note that passing a password on the command line is 92: potentially insecure as the password may be visible in the process list 93: (see ps(1)) and/or stored in a command history file. 94: .PP 95: \fB\-\-password\-tries\fR NUMBER 96: .IP 97: Prompt NUMBER of times for a password until the correct password is entered. 98: Default is to prompt three times. 99: .PP 100: \fB\-P\fR, \fB\-\-protect\-hidden\fR 101: .IP 102: Write\-protect a hidden volume when mapping an outer volume. Before mapping the 103: outer volume, the user will be prompted for a password to open the hidden 104: volume. The size and position of the hidden volume is then determined and the 105: outer volume is mounted with all sectors belonging to the hidden volume 106: protected against write operations. When a write to the protected area is 107: prevented, the whole volume is switched to read\-only mode. Verbose list command 108: (\fB\-vl\fR) can be used to query the state of the hidden volume protection. Warning 109: message is displayed when a volume switched to read\-only is being dismounted. 110: See also option \fB\-r\fR. 111: .PP 112: \fB\-r\fR, \fB\-\-read\-only\fR 113: .IP 114: Map and/or mount a volume as read\-only. Write operations to the volume may not 115: fail immediately due to the write buffering performed by the system, but the 116: physical write will still be prevented. 117: .PP 118: \fB\-\-test\fR 119: .IP 120: Test all internal algorithms used in the process of encryption and decryption. 121: .PP 122: \fB\-\-update\-time\fR 123: .IP 124: Do not preserve access and modification timestamps of volume containers and 125: access timestamps of keyfiles. By default, timestamps are restored after 126: a volume is unmapped or after a keyfile is closed. 127: .PP 128: \fB\-v\fR, \fB\-\-verbose\fR 129: .IP 130: Enable verbose output. Multiple \fB\-v\fR options can be specified to increase the 131: level of verbosity. 132: .PP 133: \fB\-V\fR, \fB\-\-version\fR 134: .IP 135: Display version information. 136: .SH EXAMPLES 137: 138: truecrypt /root/volume.tc /mnt/tc 139: .IP 140: Map a volume /root/volume.tc and mount its filesystem at /mnt/tc. 141: .PP 142: truecrypt \fB\-d\fR 143: .IP 144: Dismount and unmap all mapped volumes. 145: .PP 146: truecrypt \fB\-d\fR /root/volume.tc 147: .IP 148: Dismount and unmap a volume /root/volume.tc. 149: .PP 150: truecrypt \fB\-d\fR /mnt/tc 151: .IP 152: Dismount and unmap a volume mounted at /mnt/tc. 153: .PP 154: truecrypt \fB\-vl\fR 155: .IP 156: Display a detailed list of all mapped volumes. 157: .PP 158: truecrypt \fB\-\-device\-number\fR=\fI1\fR /dev/hdc1 && mkfs /dev/mapper/truecrypt1 159: .IP 160: Map a volume /dev/hdc1 and create a new filesystem on it. 161: .PP 162: truecrypt \fB\-P\fR /dev/hdc1 /mnt/tc 163: .IP 164: Map and mount outer volume /dev/hdc1 and protect hidden volume within it. 165: .PP 166: truecrypt \fB\-p\fR "" \fB\-p\fR "" \fB\-k\fR key1 \fB\-k\fR key2 \fB\-K\fR key_hidden \fB\-P\fR volume.tc 167: .IP 168: Map outer volume ./volume.tc and protect hidden volume within it. 169: The outer volume is opened with keyfiles ./key1 and ./key2 and the 170: hidden volume with ./key_hidden. Passwords for both volumes are empty. 171: .SH DIAGNOSTICS 172: Exit status 173: .B 0 174: is returned if all requested actions completed successfully, otherwise 175: .B 1 176: is returned. Kernel module reports errors via system log with facility 177: .BR "kern" ". See" 178: .BR "syslogd" "(8) for more information." 179: .SH "REPORTING BUGS" 180: Report bugs at <http://www.truecrypt.org/bugs>. 181: .SH COPYRIGHT 182: Copyright \(co 2004-2005 TrueCrypt Foundation. All Rights Reserved. 183: .br 184: Copyright \(co 1998-2000 Paul Le Roux. All Rights Reserved. 185: .br 186: Copyright \(co 2004 TrueCrypt Team. All Rights Reserved. 187: .br 1.1.1.2 ! root 188: Copyright \(co 1999-2005 Dr. Brian Gladman. All Rights Reserved. 1.1 root 189: .br 1.1.1.2 ! root 190: Copyright \(co 1995-1997 Eric Young. All Rights Reserved. 1.1 root 191: .br 192: Copyright \(co 2001 Markus Friedl. All Rights Reserved. 193: .SH "SEE ALSO" 194: .B http://www.truecrypt.org/documentation.php 195: .br 196: .BR "mount" "(8), " "umount" "(8), " "losetup" "(8), " 197: .BR "fuser" "(1), " "mkfs" "(8), " "fsck" "(8), " "dmsetup" "(8)"
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.