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