![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to truecrypt.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [truecrypt] / truecrypt / linux / cli / man|
Return to truecrypt.1 CVS log | Up to [truecrypt] / truecrypt / linux / cli / man |
1.1 root 1: .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35. 1.1.1.3 ! root 2: .TH TRUECRYPT "1" "April 2006" "truecrypt 4.2" "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 1.1.1.3 ! root 10: [\fIOPTIONS\fR] \fI-c | --create | -C | --change \fR[\fIVOLUME_PATH\fR] ! 11: .br ! 12: .B truecrypt 1.1 root 13: [\fIOPTIONS\fR] \fI-d | --dismount | -l | --list \fR[\fIMAPPED_VOLUME\fR] 14: .br 15: .B truecrypt 1.1.1.3 ! root 16: [\fIOPTIONS\fR] \fI--backup-headers | --restore-header FILE \fR[\fIVOLUME\fR] ! 17: .br ! 18: .B truecrypt ! 19: [\fIOPTIONS\fR] \fI--properties \fR[\fIVOLUME_PATH\fR] ! 20: .br ! 21: .B truecrypt ! 22: \fI--keyfile-create FILE\fR ! 23: .br ! 24: .B truecrypt 1.1 root 25: \fI-h | --help | --test | -V | --version\fR 26: .SH DESCRIPTION 27: Manages encrypted TrueCrypt volumes, which can be mapped as virtual block 28: devices and used as any other standard block device. All data being read 29: from a mapped TrueCrypt volume is transparently decrypted and all data being 30: written to it is transparently encrypted. 31: .SH OPTIONS 32: 33: VOLUME_PATH [MOUNT_DIRECTORY] 34: .IP 35: Open a TrueCrypt volume specified by VOLUME_PATH and map it as a block device 36: /dev/mapper/truecryptN. N is the first available device number if not 1.1.1.3 ! root 37: otherwise specified with \fB\-N\fR. To map a hidden volume, specify its password ! 38: and/or keyfiles (the outer volume cannot be mapped at the same time). ! 39: Filesystem of the mapped volume is mounted at MOUNT_DIRECTORY if specified. ! 40: See also options \fB\-\-display\-password\fR, \fB\-\-filesystem\fR, \fB\-k\fR, \fB\-M\fR, \fB\-p\fR, \fB\-P\fR, ! 41: \fB\-\-password\-tries\fR, \fB\-r\fR, \fB\-u\fR, \fB\-\-update\-time\fR. ! 42: .PP ! 43: \fB\-\-backup\-headers\fR BACKUP_FILE [VOLUME_PATH] ! 44: .IP ! 45: Backup headers of a volume specified by VOLUME_PATH to a file BACKUP_FILE. ! 46: Volume path is requested from user if not specified on command line. Both ! 47: normal/outer and hidden volume headers are stored in the backup file even ! 48: if there is no hidden volume within the volume (to preserve plausible ! 49: deniability). When restoring the volume header, it is possible to select ! 50: which header is to be restored. Note that this command drops effective user ! 51: ID. See also \fB\-\-restore\-header\fR. ! 52: .PP ! 53: \fB\-c\fR, \fB\-\-create\fR [VOLUME_PATH] ! 54: .IP ! 55: Create a new volume. Most options are requested from user if not specified ! 56: on command line. Hidden volume can be created only in an existing file or ! 57: device. Size of the hidden volume should not exceed the free space of the ! 58: filesystem on the outer volume. Hidden volume protection (see option \fB\-P\fR) ! 59: should be used to update the outer volume contents after the hidden volume ! 60: is created. Note that this command drops effective user ID. ! 61: See also options \fB\-\-cluster\fR, \fB\-\-disable\-progress\fR, \fB\-\-display\-keys\fR, ! 62: \fB\-\-encryption\fR, \fB\-k\fR, \fB\-\-filesystem\fR, \fB\-\-hash\fR, \fB\-p\fR, \fB\-\-quick\fR, \fB\-\-size\fR, \fB\-\-type\fR. Note ! 63: that passing some of the options may affect plausible deniability. See option ! 64: \fB\-p\fR for more information. ! 65: .PP ! 66: \fB\-C\fR, \fB\-\-change\fR [VOLUME_PATH] ! 67: .IP ! 68: Change a password and/or keyfile(s) of a volume. Volume path and passwords are ! 69: requested from user if not specified on command line. PKCS\-5 PRF HMAC hash ! 70: algorithm can be changed with option \fB\-\-hash\fR. See also options \fB\-k\fR, ! 71: \fB\-\-keyfile\-add\fR, \fB\-p\fR, \fB\-v\fR. 1.1 root 72: .PP 73: \fB\-d\fR, \fB\-\-dismount\fR [MAPPED_VOLUME] 74: .IP 75: Dismount and unmap mapped volumes. If MAPPED_VOLUME is not specified, all 76: volumes are dismounted and unmapped. See below for a description of 77: MAPPED_VOLUME. 78: .PP 1.1.1.3 ! root 79: \fB\-h\fR, \fB\-\-help\fR ! 80: .IP ! 81: Display help information. ! 82: .PP 1.1 root 83: \fB\-l\fR, \fB\-\-list\fR [MAPPED_VOLUME] 84: .IP 85: Display a list of mapped volumes. If MAPPED_VOLUME is not specified, all 86: volumes are listed. By default, the list contains only volume path and mapped 87: device name pairs. A more detailed list can be enabled by verbose output 88: option (\fB\-v\fR). See below for a description of MAPPED_VOLUME. 89: .PP 1.1.1.3 ! root 90: \fB\-\-keyfile\-create\fR FILE ! 91: .IP ! 92: Create a new keyfile using the random number generator. FILE argument specifies ! 93: the output file. Note that this command drops effective user ID. ! 94: .PP ! 95: \fB\-\-properties\fR [VOLUME_PATH] ! 96: .IP ! 97: Display properties of a volume specified by VOLUME_PATH. ! 98: .PP ! 99: \fB\-\-restore\-header\fR BACKUP_FILE [VOLUME_PATH] ! 100: .IP ! 101: Restore header of a volume specified by VOLUME_PATH from a file BACKUP_FILE. ! 102: Volume path is requested from user if not specified on command line. ! 103: Type of the restored volume header (normal/hidden) is requested from user if ! 104: not specified with \fB\-\-type\fR. Note that this command drops effective user ID. ! 105: See also \fB\-\-backup\-headers\fR. ! 106: .PP ! 107: \fB\-\-test\fR ! 108: .IP ! 109: Test all internal algorithms used in the process of encryption and decryption. ! 110: .PP ! 111: \fB\-V\fR, \fB\-\-version\fR ! 112: .IP ! 113: Display version information. ! 114: .PP 1.1 root 115: MAPPED_VOLUME 116: .IP 117: Specifies a mapped or mounted volume. One of the following forms can be used: 118: .IP 119: 1) Path to the encrypted TrueCrypt volume. 120: .IP 121: 2) Mount directory of the volume's filesystem (if mounted). 122: .IP 123: 3) Device number of the mapped volume. 124: .IP 125: 4) Device name of the mapped volume. 126: .PP 1.1.1.3 ! root 127: \fB\-\-cluster\fR SIZE 1.1 root 128: .IP 1.1.1.3 ! root 129: Use specified cluster size when creating a new volume. SIZE defines the number ! 130: of sectors per cluster. ! 131: .PP ! 132: \fB\-\-disable\-progress\fR ! 133: .IP ! 134: Disable display of progress information during creation of a new volume. ! 135: .PP ! 136: \fB\-\-display\-keys\fR ! 137: .IP ! 138: Display encryption keys generated during creation of a new volume. 1.1 root 139: .PP 140: \fB\-\-display\-password\fR 141: .IP 142: Display password characters while typing. 143: .PP 1.1.1.3 ! root 144: \fB\-\-encryption\fR EA ! 145: .IP ! 146: Use specified encryption algorithm when creating a new volume. ! 147: .PP 1.1 root 148: \fB\-\-filesystem\fR TYPE 149: .IP 150: Filesystem type to mount. The TYPE argument is passed to mount(8) command 1.1.1.3 ! root 151: with option \fB\-t\fR. Default type is 'auto'. When creating a new volume, this ! 152: option specifies the filesystem to be created on the new volume. 1.1 root 153: .PP 1.1.1.3 ! root 154: \fB\-\-hash\fR HASH 1.1 root 155: .IP 1.1.1.3 ! root 156: Use specified hash algorithm when creating a new volume or changing password ! 157: and/or keyfiles. 1.1 root 158: .PP 159: \fB\-k\fR, \fB\-\-keyfile\fR FILE | DIRECTORY 160: .IP 1.1.1.3 ! root 161: Use specified keyfile to open a volume to be mapped (or when changing password ! 162: and/or keyfiles). When a directory is specified, all files inside it will be ! 163: used (non\-recursively). Additional keyfiles can be specified with multiple \fB\-k\fR ! 164: options. See also option \fB\-K\fR. 1.1 root 165: .PP 166: \fB\-K\fR, \fB\-\-keyfile\-protected\fR FILE | DIRECTORY 167: .IP 168: Use specified keyfile to open a hidden volume to be protected. See also 169: options \fB\-k\fR and \fB\-P\fR. 170: .PP 1.1.1.3 ! root 171: \fB\-\-keyfile\-add\fR FILE | DIRECTORY ! 172: .IP ! 173: Add specified keyfile to a volume when changing its password and/or keyfiles. ! 174: This option must be also used to keep all previous keyfiles asigned to a ! 175: volume. See EXAMPLES for more information. ! 176: .PP ! 177: \fB\-M\fR, \fB\-\-mount\-options\fR OPTIONS 1.1 root 178: .IP 179: Filesystem mount options. The OPTIONS argument is passed to mount(8) 180: command with option \fB\-o\fR. 181: .PP 1.1.1.3 ! root 182: \fB\-N\fR, \fB\-\-device\-number\fR N ! 183: .IP ! 184: Use device number N when mapping a volume as a block device ! 185: /dev/mapper/truecryptN. Default is the first available device. ! 186: .PP 1.1 root 187: \fB\-p\fR, \fB\-\-password\fR PASSWORD 188: .IP 189: Use specified password to open a volume. Additional passwords can be 190: specified with multiple \fB\-p\fR options. An empty password can also be specified 191: ("" in most shells). Note that passing a password on the command line is 192: potentially insecure as the password may be visible in the process list 193: (see ps(1)) and/or stored in a command history file. 194: .PP 195: \fB\-\-password\-tries\fR NUMBER 196: .IP 197: Prompt NUMBER of times for a password until the correct password is entered. 198: Default is to prompt three times. 199: .PP 200: \fB\-P\fR, \fB\-\-protect\-hidden\fR 201: .IP 202: Write\-protect a hidden volume when mapping an outer volume. Before mapping the 203: outer volume, the user will be prompted for a password to open the hidden 204: volume. The size and position of the hidden volume is then determined and the 1.1.1.3 ! root 205: outer volume is mapped with all sectors belonging to the hidden volume 1.1 root 206: protected against write operations. When a write to the protected area is 207: prevented, the whole volume is switched to read\-only mode. Verbose list command 208: (\fB\-vl\fR) can be used to query the state of the hidden volume protection. Warning 209: message is displayed when a volume switched to read\-only is being dismounted. 210: See also option \fB\-r\fR. 211: .PP 1.1.1.3 ! root 212: \fB\-\-quick\fR ! 213: .IP ! 214: Use quick format when creating a new volume. This option can be used only ! 215: when creating a device\-hosted volume. Quick format is always used when ! 216: creating a hidden volume. ! 217: .PP 1.1 root 218: \fB\-r\fR, \fB\-\-read\-only\fR 219: .IP 1.1.1.3 ! root 220: Map and mount a volume as read\-only. Write operations to the volume may not 1.1 root 221: fail immediately due to the write buffering performed by the system, but the 222: physical write will still be prevented. 223: .PP 1.1.1.3 ! root 224: \fB\-\-size\fR SIZE 1.1 root 225: .IP 1.1.1.3 ! root 226: Use specified size when creating a new volume. SIZE is defined as number of ! 227: bytes or, when a size suffix K/M/G is used, Kilobytes/Megabytes/Gigabytes. ! 228: Note that size must be a multiple of 512 bytes. ! 229: .PP ! 230: \fB\-\-type\fR TYPE ! 231: .IP ! 232: Use specified volume type when creating a new volume or restoring a volume ! 233: header. TYPE can be 'normal' or 'hidden'. ! 234: .PP ! 235: \fB\-u\fR, \fB\-\-user\-mount\fR ! 236: .IP ! 237: Set default user and group ID of the filesystem being mounted to the user and ! 238: group ID of the parent process. Some filesystems (like FAT) do not support ! 239: user permissions and, therefore, it is necessary to supply a default user and ! 240: group ID to the system when mounting such filesystems. 1.1 root 241: .PP 242: \fB\-\-update\-time\fR 243: .IP 244: Do not preserve access and modification timestamps of volume containers and 245: access timestamps of keyfiles. By default, timestamps are restored after 246: a volume is unmapped or after a keyfile is closed. 247: .PP 248: \fB\-v\fR, \fB\-\-verbose\fR 249: .IP 250: Enable verbose output. Multiple \fB\-v\fR options can be specified to increase the 251: level of verbosity. 252: .SH EXAMPLES 253: 254: truecrypt /root/volume.tc /mnt/tc 255: .IP 1.1.1.3 ! root 256: Map a volume /root/volume.tc and mount its filesystem at directory /mnt/tc. ! 257: .PP ! 258: truecrypt \fB\-u\fR /dev/hda2 /mnt/tc ! 259: .IP ! 260: Map a volume /dev/hda2 (first ATA disk, primary partition 2) and mount its ! 261: filesystem at /mnt/tc. Default user\-id is set, which is useful when mounting ! 262: a filesystem like FAT under a non\-admin user account. 1.1 root 263: .PP 264: truecrypt \fB\-d\fR 265: .IP 266: Dismount and unmap all mapped volumes. 267: .PP 268: truecrypt \fB\-d\fR /root/volume.tc 269: .IP 270: Dismount and unmap a volume /root/volume.tc. 271: .PP 272: truecrypt \fB\-d\fR /mnt/tc 273: .IP 274: Dismount and unmap a volume mounted at /mnt/tc. 275: .PP 276: truecrypt \fB\-vl\fR 277: .IP 278: Display a detailed list of all mapped volumes. 279: .PP 1.1.1.3 ! root 280: truecrypt \fB\-N\fR 1 /dev/hdc1 && mkfs /dev/mapper/truecrypt1 1.1 root 281: .IP 282: Map a volume /dev/hdc1 and create a new filesystem on it. 283: .PP 284: truecrypt \fB\-P\fR /dev/hdc1 /mnt/tc 285: .IP 286: Map and mount outer volume /dev/hdc1 and protect hidden volume within it. 287: .PP 288: 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 289: .IP 290: Map outer volume ./volume.tc and protect hidden volume within it. 291: The outer volume is opened with keyfiles ./key1 and ./key2 and the 292: hidden volume with ./key_hidden. Passwords for both volumes are empty. 1.1.1.3 ! root 293: .PP ! 294: truecrypt \fB\-c\fR ! 295: .IP ! 296: Create a new volume. ! 297: .PP ! 298: truecrypt \fB\-k\fR keyfile \fB\-\-size\fR 10M \fB\-\-encryption\fR AES \fB\-\-hash\fR SHA\-1 \fB\-c\fR vol.tc ! 299: .IP ! 300: Create a new volume. Options which are not specified on command line are ! 301: requested from the user. ! 302: .PP ! 303: truecrypt \fB\-\-type\fR normal \fB\-c\fR volume.tc && truecrypt \fB\-\-type\fR hidden \fB\-c\fR volume.tc ! 304: .IP ! 305: Create a new volume and then create a hidden volume inside it. ! 306: .PP ! 307: truecrypt \fB\-\-keyfile\-add\fR keyfile \fB\-C\fR volume.tc ! 308: .IP ! 309: Change password and add a new keyfile to volume. ! 310: .PP ! 311: truecrypt \fB\-k\fR keyfile \fB\-C\fR volume.tc ! 312: .IP ! 313: Change password and remove a keyfile from volume. ! 314: .PP ! 315: truecrypt \fB\-k\fR keyfile \fB\-\-keyfile\-add\fR keyfile \fB\-C\fR volume.tc ! 316: .IP ! 317: Change password and keep previous keyfile. 1.1 root 318: .SH DIAGNOSTICS 319: Exit status 320: .B 0 321: is returned if all requested actions completed successfully, otherwise 322: .B 1 323: is returned. Kernel module reports errors via system log with facility 324: .BR "kern" ". See" 325: .BR "syslogd" "(8) for more information." 326: .SH "REPORTING BUGS" 327: Report bugs at <http://www.truecrypt.org/bugs>. 328: .SH COPYRIGHT 1.1.1.3 ! root 329: Copyright \(co 2004-2006 TrueCrypt Foundation. All Rights Reserved. 1.1 root 330: .br 331: Copyright \(co 1998-2000 Paul Le Roux. All Rights Reserved. 332: .br 333: Copyright \(co 2004 TrueCrypt Team. All Rights Reserved. 334: .br 1.1.1.2 root 335: Copyright \(co 1999-2005 Dr. Brian Gladman. All Rights Reserved. 1.1 root 336: .br 1.1.1.2 root 337: Copyright \(co 1995-1997 Eric Young. All Rights Reserved. 1.1 root 338: .br 339: Copyright \(co 2001 Markus Friedl. All Rights Reserved. 340: .SH "SEE ALSO" 341: .B http://www.truecrypt.org/documentation.php 342: .br 343: .BR "mount" "(8), " "umount" "(8), " "losetup" "(8), " 344: .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.