diff options
Diffstat (limited to 'doc/html/Command Line Usage.html')
-rw-r--r-- | doc/html/Command Line Usage.html | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/html/Command Line Usage.html b/doc/html/Command Line Usage.html index c463b04c..004eccc8 100644 --- a/doc/html/Command Line Usage.html +++ b/doc/html/Command Line Usage.html @@ -38,73 +38,77 @@ <p>Note that this section applies to the Windows version of VeraCrypt. For information on command line usage applying to the <strong>Linux and Mac OS X versions</strong>, please run: veracrypt –h</p> <table border="1" cellspacing="0" cellpadding="1"> <tbody> <tr> <td><em>/help</em> or <em>/?</em></td> <td>Display command line help.</td> </tr> <tr> <td><em>/truecrypt or /tc</em></td> <td>Activate TrueCrypt compatibility mode which enables mounting volumes created with TrueCrypt 6.x and 7.x series.</td> </tr> <tr> <td><em>/hash</em></td> <td>It must be followed by a parameter indicating the PRF hash algorithm to use when mounting the volume. Possible values for /hash parameter are: sha256, sha-256, sha512, sha-512, whirlpool, blake2s and blake2s-256. When /hash is omitted, VeraCrypt will try all possible PRF algorithms thus lengthening the mount operation time.</td> </tr> <tr> <td id="volume"><em>/volume</em> or <em>/v</em></td> <td> -<p>It must be followed by a parameter indicating the file and path name of a VeraCrypt volume to mount (do not use when dismounting) or the Volume ID of the disk/partition to mount.<br> +<p>It must be followed by a parameter indicating the file and path name of a VeraCrypt volume to mount (do not use when unmounting) or the Volume ID of the disk/partition to mount.<br> The syntax of the volume ID is <strong>ID:XXXXXX...XX</strong> where the XX part is a 64 hexadecimal characters string that represent the 32-Bytes ID of the desired volume to mount.<br> <br> To mount a partition/device-hosted volume, use, for example, /v \Device\Harddisk1\Partition3 (to determine the path to a partition/device, run VeraCrypt and click <em>Select Device</em>). You can also mount a partition or dynamic volume using its volume name (for example, /v \\?\Volume{5cceb196-48bf-46ab-ad00-70965512253a}\). To determine the volume name use e.g. mountvol.exe. Also note that device paths are case-sensitive.<br> <br> You can also specify the Volume ID of the partition/device-hosted volume to mount, for example: /v ID:53B9A8D59CC84264004DA8728FC8F3E2EE6C130145ABD3835695C29FD601EDCA. The Volume ID value can be retrieved using the volume properties dialog.</p> </td> </tr> <tr> <td><em>/letter</em> or <em>/l</em></td> <td>It must be followed by a parameter indicating the driver letter to mount the volume as. When /l is omitted and when /a is used, the first free drive letter is used.</td> </tr> <tr> <td><em>/explore</em> or <em>/e</em></td> <td>Open an Explorer window after a volume has been mounted.</td> </tr> <tr> <td><em>/beep</em> or <em>/b</em></td> -<td>Beep after a volume has been successfully mounted or dismounted.</td> +<td>Beep after a volume has been successfully mounted or unmounted.</td> </tr> <tr> <td><em>/auto</em> or <em>/a</em></td> <td>If no parameter is specified, automatically mount the volume. If devices is specified as the parameter (e.g., /a devices), auto-mount all currently accessible device/partition-hosted VeraCrypt volumes. If favorites is specified as the parameter, auto-mount favorite volumes. Note that /auto is implicit if /quit and /volume are specified. If you need to prevent the application window from appearing, use /quit.</td> </tr> <tr> +<td><em>/unmount</em> or <em>/u</em></td> +<td>Unmount volume specified by drive letter (e.g., /u x). When no drive letter is specified, unmounts all currently mounted VeraCrypt volumes.</td> +</tr> +<tr> <td><em>/dismount</em> or <em>/d</em></td> -<td>Dismount volume specified by drive letter (e.g., /d x). When no drive letter is specified, dismounts all currently mounted VeraCrypt volumes.</td> +<td>Deprecated. Please use /unmount or /u.</td> </tr> <tr> <td><em>/force</em> or <em>/f</em></td> -<td>Forces dismount (if the volume to be dismounted contains files being used by the system or an application) and forces mounting in shared mode (i.e., without exclusive access).</td> +<td>Forces unmount (if the volume to be unmounted contains files being used by the system or an application) and forces mounting in shared mode (i.e., without exclusive access).</td> </tr> <tr> <td><em>/keyfile</em> or <em>/k</em></td> <td>It must be followed by a parameter specifying a keyfile or a keyfile search path. For multiple keyfiles, specify e.g.: /k c:\keyfile1.dat /k d:\KeyfileFolder /k c:\kf2 To specify a keyfile stored on a security token or smart card, use the following syntax: token://slot/SLOT_NUMBER/file/FILE_NAME</td> </tr> <tr id="tryemptypass"> <td><em>/tryemptypass </em></td> <td>ONLY when default keyfile configured or when a keyfile is specified in the command line.<br> If it is followed by <strong>y</strong> or <strong>yes</strong> or if no parameter is specified: try to mount using an empty password and the keyfile before displaying password prompt.<br> if it is followed by <strong>n </strong>or<strong> no</strong>: don't try to mount using an empty password and the keyfile, and display password prompt right away.</td> </tr> <tr> <td><em>/nowaitdlg</em></td> <td>If it is followed by <strong>y</strong> or <strong>yes</strong> or if no parameter is specified: don’t display the waiting dialog while performing operations like mounting volumes.<br> If it is followed by <strong>n</strong> or <strong>no</strong>: force the display waiting dialog is displayed while performing operations.</td> </tr> <tr> <td><em>/secureDesktop</em></td> <td>If it is followed by <strong>y</strong> or <strong>yes</strong> or if no parameter is specified: display password dialog and token PIN dialog in a dedicated secure desktop to protect against certain types of attacks.<br> @@ -297,29 +301,29 @@ It has no parameters and it indicates that no message box or dialog will be disp <tr> <td><em>/protectMemory</em> </td> <td>Activates a mechanism that protects VeraCrypt Format process memory from being accessed by other non-admin processes.</td> </tr> <tr> <td><em>/secureDesktop</em></td> <td>If it is followed by <strong>y</strong> or <strong>yes</strong> or if no parameter is specified: display password dialog and token PIN dialog in a dedicated secure desktop to protect against certain types of attacks.<br> If it is followed by <strong>n</strong> or <strong>no</strong>: the password dialog and token PIN dialog are displayed in the normal desktop.</td> </tr> </tbody> </table> <h4>Syntax</h4> <p>VeraCrypt.exe [/tc] [/hash {sha256|sha-256|sha512|sha-512|whirlpool |blake2s|blake2s-256}][/a [devices|favorites]] [/b] [/c [y|n|f]] [/d [drive letter]] [/e] [/f] [/h [y|n]] [/k keyfile or search path] [tryemptypass [y|n]] [/l drive letter] [/m {bk|rm|recovery|ro|sm|ts|noattach}] [/p password] [/pim pimvalue] [/q [background|preferences]] [/s] [/tokenlib path] [/v volume] [/w]</p> <p>"VeraCrypt Format.exe" [/n] [/create] [/size number[{K|M|G|T}]] [/p password] [/encryption {AES | Serpent | Twofish | Camellia | Kuznyechik | AES(Twofish) | AES(Twofish(Serpent)) | Serpent(AES) | Serpent(Twofish(AES)) | Twofish(Serpent) | Camellia(Kuznyechik) | Kuznyechik(Twofish) | Camellia(Serpent) | Kuznyechik(AES) | Kuznyechik(Serpent(Camellia))}] [/hash {sha256|sha-256|sha512|sha-512|whirlpool|blake2s|blake2s-256}] [/filesystem {None|FAT|NTFS|ExFAT|ReFS}] [/dynamic] [/force] [/silent] [/noisocheck] [FastCreateFile] [/quick]</p> <p>Note that the order in which options are specified does not matter.</p> <h4>Examples</h4> <p>Mount the volume <em>d:\myvolume</em> as the first free drive letter, using the password prompt (the main program window will not be displayed):</p> <p>veracrypt /q /v d:\myvolume</p> -<p>Dismount a volume mounted as the drive letter <em>X</em> (the main program window will not be displayed):</p> +<p>Unmount a volume mounted as the drive letter <em>X</em> (the main program window will not be displayed):</p> <p>veracrypt /q /d x</p> <p>Mount a volume called <em>myvolume.tc</em> using the password <em>MyPassword</em>, as the drive letter <em>X</em>. VeraCrypt will open an explorer window and beep; mounting will be automatic:</p> <p>veracrypt /v myvolume.tc /l x /a /p MyPassword /e /b</p> <p>Create a 10 MB file container using the password <em>test</em> and formatted using FAT:</p> <p><code>"C:\Program Files\VeraCrypt\VeraCrypt Format.exe" /create c:\Data\test.hc /password test /hash sha512 /encryption serpent /filesystem FAT /size 10M /force</code></p> </div> </div><div class="ClearBoth"></div></body></html> |