--- truecrypt/linux/cli/man/truecrypt.1 2018/04/24 16:45:04 1.1.1.3 +++ truecrypt/linux/cli/man/truecrypt.1 2018/04/24 16:47:49 1.1.1.6 @@ -1,5 +1,5 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35. -.TH TRUECRYPT "1" "April 2006" "truecrypt 4.2" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH TRUECRYPT "1" "May 2007" "truecrypt 4.3a" "User Commands" .SH NAME truecrypt - manage TrueCrypt volumes .SH SYNOPSIS @@ -7,6 +7,9 @@ truecrypt - manage TrueCrypt volumes [\fIOPTIONS\fR] \fIVOLUME_PATH \fR[\fIMOUNT_DIRECTORY\fR] .br .B truecrypt +[\fIOPTIONS\fR] \fI-i\fR +.br +.B truecrypt [\fIOPTIONS\fR] \fI-c | --create | -C | --change \fR[\fIVOLUME_PATH\fR] .br .B truecrypt @@ -19,7 +22,7 @@ truecrypt - manage TrueCrypt volumes [\fIOPTIONS\fR] \fI--properties \fR[\fIVOLUME_PATH\fR] .br .B truecrypt -\fI--keyfile-create FILE\fR +[\fIOPTIONS\fR] \fI--keyfile-create FILE\fR .br .B truecrypt \fI-h | --help | --test | -V | --version\fR @@ -34,11 +37,13 @@ VOLUME_PATH [MOUNT_DIRECTORY] .IP Open a TrueCrypt volume specified by VOLUME_PATH and map it as a block device /dev/mapper/truecryptN. N is the first available device number if not -otherwise specified with \fB\-N\fR. To map a hidden volume, specify its password +otherwise specified with \fB\-N\fR. Filesystem of the mapped volume is mounted at +MOUNT_DIRECTORY if specified. To open a hidden volume, specify its password and/or keyfiles (the outer volume cannot be mapped at the same time). -Filesystem of the mapped volume is mounted at MOUNT_DIRECTORY if specified. -See also options \fB\-\-display\-password\fR, \fB\-\-filesystem\fR, \fB\-k\fR, \fB\-M\fR, \fB\-p\fR, \fB\-P\fR, -\fB\-\-password\-tries\fR, \fB\-r\fR, \fB\-u\fR, \fB\-\-update\-time\fR. +See also EXAMPLES and options \fB\-\-display\-password\fR, \fB\-\-filesystem\fR, \fB\-k\fR, \fB\-M\fR, \fB\-p\fR, \fB\-P\fR, +\fB\-\-password\-tries\fR, \fB\-r\fR, \fB\-u\fR, \fB\-\-update\-time\fR. Note that passing some of the options +may affect security (see options \fB\-i\fR and \fB\-p\fR for more information). +This command requires administrator privileges (sudo(8) is used if available). .PP \fB\-\-backup\-headers\fR BACKUP_FILE [VOLUME_PATH] .IP @@ -47,8 +52,7 @@ Volume path is requested from user if no normal/outer and hidden volume headers are stored in the backup file even if there is no hidden volume within the volume (to preserve plausible deniability). When restoring the volume header, it is possible to select -which header is to be restored. Note that this command drops effective user -ID. See also \fB\-\-restore\-header\fR. +which header is to be restored. See also \fB\-\-restore\-header\fR. .PP \fB\-c\fR, \fB\-\-create\fR [VOLUME_PATH] .IP @@ -57,40 +61,49 @@ on command line. Hidden volume can be cr device. Size of the hidden volume should not exceed the free space of the filesystem on the outer volume. Hidden volume protection (see option \fB\-P\fR) should be used to update the outer volume contents after the hidden volume -is created. Note that this command drops effective user ID. +is created. WARNING: To prevent data corruption, you should follow the +instructions in the EXAMPLES section on how to create a hidden volume. See also options \fB\-\-cluster\fR, \fB\-\-disable\-progress\fR, \fB\-\-display\-keys\fR, -\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 -that passing some of the options may affect plausible deniability. See option -\fB\-p\fR for more information. +\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, +\fB\-\-type\fR. Note that passing some of the options may affect security (see option +\fB\-p\fR for more information). .PP \fB\-C\fR, \fB\-\-change\fR [VOLUME_PATH] .IP Change a password and/or keyfile(s) of a volume. Volume path and passwords are requested from user if not specified on command line. PKCS\-5 PRF HMAC hash algorithm can be changed with option \fB\-\-hash\fR. See also options \fB\-k\fR, -\fB\-\-keyfile\-add\fR, \fB\-p\fR, \fB\-v\fR. +\fB\-\-keyfile\-add\fR, \fB\-p\fR, \fB\-\-random\-source\fR, \fB\-v\fR. .PP \fB\-d\fR, \fB\-\-dismount\fR [MAPPED_VOLUME] .IP Dismount and unmap mapped volumes. If MAPPED_VOLUME is not specified, all volumes are dismounted and unmapped. See below for a description of MAPPED_VOLUME. +This command requires administrator privileges (sudo(8) is used if available). .PP \fB\-h\fR, \fB\-\-help\fR .IP Display help information. .PP +\fB\-i\fR, \fB\-\-interactive\fR +.IP +Map and mount a volume interactively. Options which may affect security are +requested from the user. See option \fB\-p\fR for more information. +This command requires administrator privileges (sudo(8) is used if available). +.PP \fB\-l\fR, \fB\-\-list\fR [MAPPED_VOLUME] .IP Display a list of mapped volumes. If MAPPED_VOLUME is not specified, all volumes are listed. By default, the list contains only volume path and mapped device name pairs. A more detailed list can be enabled by verbose output option (\fB\-v\fR). See below for a description of MAPPED_VOLUME. +This command requires administrator privileges (sudo(8) is used if available). .PP \fB\-\-keyfile\-create\fR FILE .IP Create a new keyfile using the random number generator. FILE argument specifies -the output file. Note that this command drops effective user ID. +the output file. .PP \fB\-\-properties\fR [VOLUME_PATH] .IP @@ -101,8 +114,7 @@ Display properties of a volume specified Restore header of a volume specified by VOLUME_PATH from a file BACKUP_FILE. Volume path is requested from user if not specified on command line. Type of the restored volume header (normal/hidden) is requested from user if -not specified with \fB\-\-type\fR. Note that this command drops effective user ID. -See also \fB\-\-backup\-headers\fR. +not specified with \fB\-\-type\fR. See also \fB\-\-backup\-headers\fR. .PP \fB\-\-test\fR .IP @@ -110,9 +122,8 @@ Test all internal algorithms used in the .PP \fB\-V\fR, \fB\-\-version\fR .IP -Display version information. -.PP -MAPPED_VOLUME +Display program version and legal notices. +.SS "MAPPED_VOLUME:" .IP Specifies a mapped or mounted volume. One of the following forms can be used: .IP @@ -141,7 +152,7 @@ Display encryption keys generated during .IP Display password characters while typing. .PP -\fB\-\-encryption\fR EA +\fB\-\-encryption\fR ENCRYPTION_ALGORITHM .IP Use specified encryption algorithm when creating a new volume. .PP @@ -161,12 +172,14 @@ and/or keyfiles. Use specified keyfile to open a volume to be mapped (or when changing password and/or keyfiles). When a directory is specified, all files inside it will be used (non\-recursively). Additional keyfiles can be specified with multiple \fB\-k\fR -options. See also option \fB\-K\fR. +options. Empty keyfile (\fB\-k\fR '') disables interactive requests for keyfiles +(e.g., when creating a new volume). See also option \fB\-K\fR. .PP \fB\-K\fR, \fB\-\-keyfile\-protected\fR FILE | DIRECTORY .IP -Use specified keyfile to open a hidden volume to be protected. See also -options \fB\-k\fR and \fB\-P\fR. +Use specified keyfile to open a hidden volume to be protected. This option +may be used only when mounting an outer volume with hidden volume protected. +See also options \fB\-k\fR and \fB\-P\fR. .PP \fB\-\-keyfile\-add\fR FILE | DIRECTORY .IP @@ -177,18 +190,22 @@ volume. See EXAMPLES for more informatio \fB\-M\fR, \fB\-\-mount\-options\fR OPTIONS .IP Filesystem mount options. The OPTIONS argument is passed to mount(8) -command with option \fB\-o\fR. +command with option \fB\-o\fR. See also options \fB\-r\fR and \fB\-u\fR. .PP \fB\-N\fR, \fB\-\-device\-number\fR N .IP Use device number N when mapping a volume as a block device /dev/mapper/truecryptN. Default is the first available device. .PP +\fB\-\-overwrite\fR +.IP +Overwrite files without prompting the user for confirmation. +.PP \fB\-p\fR, \fB\-\-password\fR PASSWORD .IP Use specified password to open a volume. Additional passwords can be specified with multiple \fB\-p\fR options. An empty password can also be specified -("" in most shells). Note that passing a password on the command line is +('' in most shells). Note that passing a password on the command line is potentially insecure as the password may be visible in the process list (see ps(1)) and/or stored in a command history file. .PP @@ -207,7 +224,7 @@ protected against write operations. When prevented, the whole volume is switched to read\-only mode. Verbose list command (\fB\-vl\fR) can be used to query the state of the hidden volume protection. Warning message is displayed when a volume switched to read\-only is being dismounted. -See also option \fB\-r\fR. +See also options \fB\-r\fR and \fB\-i\fR. .PP \fB\-\-quick\fR .IP @@ -215,6 +232,11 @@ Use quick format when creating a new vol when creating a device\-hosted volume. Quick format is always used when creating a hidden volume. .PP +\fB\-\-random\-source\fR FILE +.IP +Use FILE as a source of random numbers. Standard input is used if '\-' is +specified. +.PP \fB\-r\fR, \fB\-\-read\-only\fR .IP Map and mount a volume as read\-only. Write operations to the volume may not @@ -234,16 +256,16 @@ header. TYPE can be 'normal' or 'hidden' .PP \fB\-u\fR, \fB\-\-user\-mount\fR .IP -Set default user and group ID of the filesystem being mounted to the user and -group ID of the parent process. Some filesystems (like FAT) do not support -user permissions and, therefore, it is necessary to supply a default user and -group ID to the system when mounting such filesystems. +Make a volume being mounted accessible in a non\-administrator account. Some +filesystems (e.g., FAT) do not support Unix\-style access control and it is +necessary to use this option when mounting them. Ownership of the mounted +filesystem is determined by environment variables set by sudo(8) command. +Note that Unix\-style filesystems (e.g., ext2) do not support this option. .PP \fB\-\-update\-time\fR .IP -Do not preserve access and modification timestamps of volume containers and -access timestamps of keyfiles. By default, timestamps are restored after -a volume is unmapped or after a keyfile is closed. +Do not preserve access and modification timestamps of file containers. +By default, timestamps are restored after a volume is unmapped. .PP \fB\-v\fR, \fB\-\-verbose\fR .IP @@ -259,7 +281,11 @@ truecrypt \fB\-u\fR /dev/hda2 /mnt/tc .IP Map a volume /dev/hda2 (first ATA disk, primary partition 2) and mount its filesystem at /mnt/tc. Default user\-id is set, which is useful when mounting -a filesystem like FAT under a non\-admin user account. +a filesystem, such as FAT, for use in a non\-administrative account. +.PP +truecrypt \fB\-i\fR +.IP +Map and mount a volume. Options are requested interactively. .PP truecrypt \fB\-d\fR .IP @@ -285,7 +311,7 @@ truecrypt \fB\-P\fR /dev/hdc1 /mnt/tc .IP Map and mount outer volume /dev/hdc1 and protect hidden volume within it. .PP -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 +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 .IP Map outer volume ./volume.tc and protect hidden volume within it. The outer volume is opened with keyfiles ./key1 and ./key2 and the @@ -293,17 +319,18 @@ hidden volume with ./key_hidden. Passwor .PP truecrypt \fB\-c\fR .IP -Create a new volume. +Create a new volume. Options are requested interactively. +.PP +truecrypt \fB\-c\fR /dev/hda2 +.IP +Create a new volume hosted at the second primary partition of the first +ATA disk. .PP truecrypt \fB\-k\fR keyfile \fB\-\-size\fR 10M \fB\-\-encryption\fR AES \fB\-\-hash\fR SHA\-1 \fB\-c\fR vol.tc .IP Create a new volume. Options which are not specified on command line are requested from the user. .PP -truecrypt \fB\-\-type\fR normal \fB\-c\fR volume.tc && truecrypt \fB\-\-type\fR hidden \fB\-c\fR volume.tc -.IP -Create a new volume and then create a hidden volume inside it. -.PP truecrypt \fB\-\-keyfile\-add\fR keyfile \fB\-C\fR volume.tc .IP Change password and add a new keyfile to volume. @@ -315,6 +342,31 @@ Change password and remove a keyfile fro truecrypt \fB\-k\fR keyfile \fB\-\-keyfile\-add\fR keyfile \fB\-C\fR volume.tc .IP Change password and keep previous keyfile. +.SS "Creating a hidden volume without risking data corruption:" +.IP +1) Create an outer volume: +.IP +truecrypt \fB\-\-type\fR normal \fB\-\-size\fR 100M \fB\-c\fR volume.tc +.IP +2) Create a hidden volume: +.IP +truecrypt \fB\-\-type\fR hidden \fB\-\-size\fR 50M \fB\-c\fR volume.tc +.IP +3) Mount the outer volume with the hidden volume protected: +.IP +truecrypt \fB\-P\fR volume.tc /mnt/tc +.IP +4) Copy files to the outer volume: +.IP +cp outer_volume_file.txt /mnt/tc +.IP +5) Dismount the outer volume: +.IP +truecrypt \fB\-d\fR volume.tc +.IP +6) If a warning message has been displayed in 5), start again from 1). Either +a larger outer volume should be created in 1), or less data should be copied +to the outer volume in 4). .SH DIAGNOSTICS Exit status .B 0 @@ -324,21 +376,23 @@ is returned. Kernel module reports error .BR "kern" ". See" .BR "syslogd" "(8) for more information." .SH "REPORTING BUGS" -Report bugs at . +Report bugs at . .SH COPYRIGHT -Copyright \(co 2004-2006 TrueCrypt Foundation. All Rights Reserved. +Copyright \(co 2003-2007 TrueCrypt Foundation. All Rights Reserved. .br Copyright \(co 1998-2000 Paul Le Roux. All Rights Reserved. .br -Copyright \(co 2004 TrueCrypt Team. All Rights Reserved. -.br -Copyright \(co 1999-2005 Dr. Brian Gladman. All Rights Reserved. +Copyright \(co 1999-2006 Dr. Brian Gladman. All Rights Reserved. .br Copyright \(co 1995-1997 Eric Young. All Rights Reserved. .br Copyright \(co 2001 Markus Friedl. All Rights Reserved. +.PP +Released under the TrueCrypt Collective License 1.2 .SH "SEE ALSO" -.B http://www.truecrypt.org/documentation.php +.B http://www.truecrypt.org/docs/ +.br +.B /usr/share/truecrypt/doc/TrueCrypt-User-Guide.pdf .br .BR "mount" "(8), " "umount" "(8), " "losetup" "(8), " .BR "fuser" "(1), " "mkfs" "(8), " "fsck" "(8), " "dmsetup" "(8)"