FreeOTFE Explorer logo FreeOTFE Explorer
Free disk encryption software for PCs and PDAs
(PDA version of WWW site)

Command Line Interface

Command Line Interface


Synopsis

FreeOTFEExplorer.exe /mount /volume <volume> [/freeotfe | /linux] [/readonly] 
             [/offset <offset>] [/nocdbatoffset] [/keyfile <keyfile>] [/lesfile <LES file>]
             [/password <password>] [/silent] 


Description

FreeOTFE Explorer supports a number of command line options that allow a number of its main functions to be carried out from the command line or via MS Windows shortcuts.


Options

Note that "-" may be substituted in place of "/", if required.

Note: Although there is currently no option to specify which drive letter a volume should be mounted as, this may be set on any given FreeOTFE volume by selecting "Tools | Change volume/keyfile password/details..."

/freeotfe
The specified volume is a FreeOTFE volume. If a volume type (FreeOTFE/Linux) isn't specified, the user will be prompted for this information.
/keyfile <keyfile>
Keyfile to be used when mounting a FreeOTFE volume. Only valid when mounting FreeOTFE volumes
/lesfile <LES file>
File from which to read Linux encryption settings from. Only valid when mounting non-LUKS Linux volumes
/linux
The specified volume is a Linux volume. If a volume type (FreeOTFE/Linux) isn't specified, the user will be prompted for this information.
/mount
Mount indicated file/partition
/nocdbatoffset
Indicates there is no CDB stored from the offset specified by "/offset". Only meaningful when both "/offset", "/freeotfe" and "/keyfile" are used.
/offset <offset>
Use specified offset when mounting. This may be specified using GB/MB/KB units, or with no units for an offset in bytes (e.g. 5GB or 5368709120 for a 5GB offset). Note: If the value used for the offset has has a space in it, it should be surrounded by quotes (e.g. "10 GB" or 10GB are both valid)
/password <password>
Use specified password when mounting
/readonly
Mount the volume readonly
/silent
Can be used when mounting a volume to prevent the password entry dialog showing
/volume <volume>
The volume filename/partition to be used. When using a volume file, this should be set to the full path and filename of a volume file. Partitions should be specified in the form: "\Device\HarddiskX\PartitionY", where X is 0 based, while Y starts from 1 to indicate a particular partition, or 0 to indicate the entire disk.
Important: If the volume filename has any spaces in it, then it should be enclosed in double quotes (").


Exit Codes

When run at the command line, FreeOTFE Explorer will terminate with one of the following exit codes:

Exit code
Meaning
0 Success
100
Invalid/unrecognised command line
101
Unable to connect to FreeOTFE Explorer driver
102
Unable to mount volume
106
The requested operation requires administrative privileges
999
Other error


Examples

Mounting a FreeOTFE volume:
FreeOTFEExplorer.exe /mount /volume "C:\My Private Data\my encrypted volume.dat" /freeotfe

Mounting a Linux volume readonly:
FreeOTFEExplorer.exe /mount /volume "C:\My Private Data\my encrypted volume.dat" /linux /readonly

Mounting a FreeOTFE partition::
FreeOTFEExplorer.exe /mount /volume "\Device\Harddisk0\Partition1" /freeotfe /readonly