![[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. 1.1.1.6 ! root 2: .TH TRUECRYPT "1" "May 2007" "truecrypt 4.3a" "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.6 ! root 46: This command requires administrator privileges (sudo(8) is used if available). 1.1.1.3 root 47: .PP 48: \fB\-\-backup\-headers\fR BACKUP_FILE [VOLUME_PATH] 49: .IP 50: Backup headers of a volume specified by VOLUME_PATH to a file BACKUP_FILE. 51: Volume path is requested from user if not specified on command line. Both 52: normal/outer and hidden volume headers are stored in the backup file even 53: if there is no hidden volume within the volume (to preserve plausible 54: deniability). When restoring the volume header, it is possible to select 1.1.1.6 ! root 55: which header is to be restored. See also \fB\-\-restore\-header\fR. 1.1.1.3 root 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. 1.1.1.3 root 66: See also options \fB\-\-cluster\fR, \fB\-\-disable\-progress\fR, \fB\-\-display\-keys\fR, 1.1.1.4 root 67: \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 68: \fB\-\-type\fR. Note that passing some of the options may affect security (see option 69: \fB\-p\fR for more information). 1.1.1.3 root 70: .PP 71: \fB\-C\fR, \fB\-\-change\fR [VOLUME_PATH] 72: .IP 73: Change a password and/or keyfile(s) of a volume. Volume path and passwords are 74: requested from user if not specified on command line. PKCS\-5 PRF HMAC hash 75: algorithm can be changed with option \fB\-\-hash\fR. See also options \fB\-k\fR, 1.1.1.4 root 76: \fB\-\-keyfile\-add\fR, \fB\-p\fR, \fB\-\-random\-source\fR, \fB\-v\fR. 1.1 root 77: .PP 78: \fB\-d\fR, \fB\-\-dismount\fR [MAPPED_VOLUME] 79: .IP 80: Dismount and unmap mapped volumes. If MAPPED_VOLUME is not specified, all 81: volumes are dismounted and unmapped. See below for a description of 82: MAPPED_VOLUME. 1.1.1.6 ! root 83: This command requires administrator privileges (sudo(8) is used if available). 1.1 root 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.6 ! root 93: This command requires administrator privileges (sudo(8) is used if available). 1.1.1.4 root 94: .PP 1.1 root 95: \fB\-l\fR, \fB\-\-list\fR [MAPPED_VOLUME] 96: .IP 97: Display a list of mapped volumes. If MAPPED_VOLUME is not specified, all 98: volumes are listed. By default, the list contains only volume path and mapped 99: device name pairs. A more detailed list can be enabled by verbose output 100: option (\fB\-v\fR). See below for a description of MAPPED_VOLUME. 1.1.1.6 ! root 101: This command requires administrator privileges (sudo(8) is used if available). 1.1 root 102: .PP 1.1.1.3 root 103: \fB\-\-keyfile\-create\fR FILE 104: .IP 105: Create a new keyfile using the random number generator. FILE argument specifies 1.1.1.6 ! root 106: the output file. 1.1.1.3 root 107: .PP 108: \fB\-\-properties\fR [VOLUME_PATH] 109: .IP 110: Display properties of a volume specified by VOLUME_PATH. 111: .PP 112: \fB\-\-restore\-header\fR BACKUP_FILE [VOLUME_PATH] 113: .IP 114: Restore header of a volume specified by VOLUME_PATH from a file BACKUP_FILE. 115: Volume path is requested from user if not specified on command line. 116: Type of the restored volume header (normal/hidden) is requested from user if 1.1.1.6 ! root 117: not specified with \fB\-\-type\fR. See also \fB\-\-backup\-headers\fR. 1.1.1.3 root 118: .PP 119: \fB\-\-test\fR 120: .IP 121: Test all internal algorithms used in the process of encryption and decryption. 122: .PP 123: \fB\-V\fR, \fB\-\-version\fR 124: .IP 1.1.1.5 root 125: Display program version and legal notices. 1.1.1.4 root 126: .SS "MAPPED_VOLUME:" 1.1 root 127: .IP 128: Specifies a mapped or mounted volume. One of the following forms can be used: 129: .IP 130: 1) Path to the encrypted TrueCrypt volume. 131: .IP 132: 2) Mount directory of the volume's filesystem (if mounted). 133: .IP 134: 3) Device number of the mapped volume. 135: .IP 136: 4) Device name of the mapped volume. 137: .PP 1.1.1.3 root 138: \fB\-\-cluster\fR SIZE 1.1 root 139: .IP 1.1.1.3 root 140: Use specified cluster size when creating a new volume. SIZE defines the number 141: of sectors per cluster. 142: .PP 143: \fB\-\-disable\-progress\fR 144: .IP 145: Disable display of progress information during creation of a new volume. 146: .PP 147: \fB\-\-display\-keys\fR 148: .IP 149: Display encryption keys generated during creation of a new volume. 1.1 root 150: .PP 151: \fB\-\-display\-password\fR 152: .IP 153: Display password characters while typing. 154: .PP 1.1.1.4 root 155: \fB\-\-encryption\fR ENCRYPTION_ALGORITHM 1.1.1.3 root 156: .IP 157: Use specified encryption algorithm when creating a new volume. 158: .PP 1.1 root 159: \fB\-\-filesystem\fR TYPE 160: .IP 161: Filesystem type to mount. The TYPE argument is passed to mount(8) command 1.1.1.3 root 162: with option \fB\-t\fR. Default type is 'auto'. When creating a new volume, this 163: option specifies the filesystem to be created on the new volume. 1.1 root 164: .PP 1.1.1.3 root 165: \fB\-\-hash\fR HASH 1.1 root 166: .IP 1.1.1.3 root 167: Use specified hash algorithm when creating a new volume or changing password 168: and/or keyfiles. 1.1 root 169: .PP 170: \fB\-k\fR, \fB\-\-keyfile\fR FILE | DIRECTORY 171: .IP 1.1.1.3 root 172: Use specified keyfile to open a volume to be mapped (or when changing password 173: and/or keyfiles). When a directory is specified, all files inside it will be 174: used (non\-recursively). Additional keyfiles can be specified with multiple \fB\-k\fR 1.1.1.5 root 175: options. Empty keyfile (\fB\-k\fR '') disables interactive requests for keyfiles 1.1.1.4 root 176: (e.g., when creating a new volume). See also option \fB\-K\fR. 1.1 root 177: .PP 178: \fB\-K\fR, \fB\-\-keyfile\-protected\fR FILE | DIRECTORY 179: .IP 1.1.1.4 root 180: Use specified keyfile to open a hidden volume to be protected. This option 181: may be used only when mounting an outer volume with hidden volume protected. 182: See also options \fB\-k\fR and \fB\-P\fR. 1.1 root 183: .PP 1.1.1.3 root 184: \fB\-\-keyfile\-add\fR FILE | DIRECTORY 185: .IP 186: Add specified keyfile to a volume when changing its password and/or keyfiles. 187: This option must be also used to keep all previous keyfiles asigned to a 188: volume. See EXAMPLES for more information. 189: .PP 190: \fB\-M\fR, \fB\-\-mount\-options\fR OPTIONS 1.1 root 191: .IP 192: Filesystem mount options. The OPTIONS argument is passed to mount(8) 1.1.1.6 ! root 193: command with option \fB\-o\fR. 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 1.1.1.6 ! root 259: Make a volume being mounted accessible in a non\-administrator account. Some ! 260: filesystems (e.g., FAT) do not support Unix\-style access control and it is ! 261: necessary to use this option when mounting them. Ownership of the mounted ! 262: filesystem is determined by environment variables set by sudo(8) command. 1.1.1.5 root 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 1.1.1.6 ! root 267: Do not preserve access and modification timestamps of file containers. ! 268: By default, timestamps are restored after a volume is unmapped. 1.1 root 269: .PP 270: \fB\-v\fR, \fB\-\-verbose\fR 271: .IP 272: Enable verbose output. Multiple \fB\-v\fR options can be specified to increase the 273: level of verbosity. 274: .SH EXAMPLES 275: 276: truecrypt /root/volume.tc /mnt/tc 277: .IP 1.1.1.3 root 278: Map a volume /root/volume.tc and mount its filesystem at directory /mnt/tc. 279: .PP 280: truecrypt \fB\-u\fR /dev/hda2 /mnt/tc 281: .IP 282: Map a volume /dev/hda2 (first ATA disk, primary partition 2) and mount its 283: filesystem at /mnt/tc. Default user\-id is set, which is useful when mounting 1.1.1.6 ! root 284: a filesystem, such as FAT, for use in a non\-administrative account. 1.1 root 285: .PP 1.1.1.4 root 286: truecrypt \fB\-i\fR 287: .IP 288: Map and mount a volume. Options are requested interactively. 289: .PP 1.1 root 290: truecrypt \fB\-d\fR 291: .IP 292: Dismount and unmap all mapped volumes. 293: .PP 294: truecrypt \fB\-d\fR /root/volume.tc 295: .IP 296: Dismount and unmap a volume /root/volume.tc. 297: .PP 298: truecrypt \fB\-d\fR /mnt/tc 299: .IP 300: Dismount and unmap a volume mounted at /mnt/tc. 301: .PP 302: truecrypt \fB\-vl\fR 303: .IP 304: Display a detailed list of all mapped volumes. 305: .PP 1.1.1.3 root 306: truecrypt \fB\-N\fR 1 /dev/hdc1 && mkfs /dev/mapper/truecrypt1 1.1 root 307: .IP 308: Map a volume /dev/hdc1 and create a new filesystem on it. 309: .PP 310: truecrypt \fB\-P\fR /dev/hdc1 /mnt/tc 311: .IP 312: Map and mount outer volume /dev/hdc1 and protect hidden volume within it. 313: .PP 1.1.1.5 root 314: 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 315: .IP 316: Map outer volume ./volume.tc and protect hidden volume within it. 317: The outer volume is opened with keyfiles ./key1 and ./key2 and the 318: hidden volume with ./key_hidden. Passwords for both volumes are empty. 1.1.1.3 root 319: .PP 320: truecrypt \fB\-c\fR 321: .IP 1.1.1.4 root 322: Create a new volume. Options are requested interactively. 323: .PP 324: truecrypt \fB\-c\fR /dev/hda2 325: .IP 326: Create a new volume hosted at the second primary partition of the first 327: ATA disk. 1.1.1.3 root 328: .PP 329: truecrypt \fB\-k\fR keyfile \fB\-\-size\fR 10M \fB\-\-encryption\fR AES \fB\-\-hash\fR SHA\-1 \fB\-c\fR vol.tc 330: .IP 331: Create a new volume. Options which are not specified on command line are 332: requested from the user. 333: .PP 334: truecrypt \fB\-\-keyfile\-add\fR keyfile \fB\-C\fR volume.tc 335: .IP 336: Change password and add a new keyfile to volume. 337: .PP 338: truecrypt \fB\-k\fR keyfile \fB\-C\fR volume.tc 339: .IP 340: Change password and remove a keyfile from volume. 341: .PP 342: truecrypt \fB\-k\fR keyfile \fB\-\-keyfile\-add\fR keyfile \fB\-C\fR volume.tc 343: .IP 344: Change password and keep previous keyfile. 1.1.1.4 root 345: .SS "Creating a hidden volume without risking data corruption:" 346: .IP 347: 1) Create an outer volume: 348: .IP 349: truecrypt \fB\-\-type\fR normal \fB\-\-size\fR 100M \fB\-c\fR volume.tc 350: .IP 351: 2) Create a hidden volume: 352: .IP 353: truecrypt \fB\-\-type\fR hidden \fB\-\-size\fR 50M \fB\-c\fR volume.tc 354: .IP 355: 3) Mount the outer volume with the hidden volume protected: 356: .IP 357: truecrypt \fB\-P\fR volume.tc /mnt/tc 358: .IP 359: 4) Copy files to the outer volume: 360: .IP 361: cp outer_volume_file.txt /mnt/tc 362: .IP 363: 5) Dismount the outer volume: 364: .IP 365: truecrypt \fB\-d\fR volume.tc 366: .IP 367: 6) If a warning message has been displayed in 5), start again from 1). Either 1.1.1.5 root 368: a larger outer volume should be created in 1), or less data should be copied 369: to the outer volume in 4). 1.1 root 370: .SH DIAGNOSTICS 371: Exit status 372: .B 0 373: is returned if all requested actions completed successfully, otherwise 374: .B 1 375: is returned. Kernel module reports errors via system log with facility 376: .BR "kern" ". See" 377: .BR "syslogd" "(8) for more information." 378: .SH "REPORTING BUGS" 1.1.1.4 root 379: Report bugs at <http://www.truecrypt.org/bugs/>. 1.1 root 380: .SH COPYRIGHT 1.1.1.5 root 381: Copyright \(co 2003-2007 TrueCrypt Foundation. All Rights Reserved. 1.1 root 382: .br 383: Copyright \(co 1998-2000 Paul Le Roux. All Rights Reserved. 384: .br 1.1.1.5 root 385: Copyright \(co 1999-2006 Dr. Brian Gladman. All Rights Reserved. 1.1 root 386: .br 1.1.1.2 root 387: Copyright \(co 1995-1997 Eric Young. All Rights Reserved. 1.1 root 388: .br 389: Copyright \(co 2001 Markus Friedl. All Rights Reserved. 1.1.1.6 ! root 390: .PP ! 391: Released under the TrueCrypt Collective License 1.2 1.1 root 392: .SH "SEE ALSO" 1.1.1.4 root 393: .B http://www.truecrypt.org/docs/ 394: .br 395: .B /usr/share/truecrypt/doc/TrueCrypt-User-Guide.pdf 1.1 root 396: .br 397: .BR "mount" "(8), " "umount" "(8), " "losetup" "(8), " 398: .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.