Command Line Interface
Both the PC and PDA version support passing parameters via a command line interface.
PC Version
Synposis
FreeOTFE.exe /mount /volume <volume> [/freeotfe|/linux] [/readonly]
FreeOTFE.exe /dismount {<drive letter>[:] | all} [/force]
FreeOTFE.exe /portable {start | on | 1 | stop | off | 0 | toggle}
Description
FreeOTFE supports a number of command line options that allow a number
of it's 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..."
/dismount {<drive letter>[:] | all}
|
Dismount indicated drive/all drives |
/force
|
When dismounting, force dismount (emergency dismount) |
/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. |
/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 |
/portable {start | on | 1 | stop | off | 0 | toggle}
|
Turn on/off portable mode |
/readonly
|
Mount the volume readonly
|
/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 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 driver; check driver is installed or portable mode is started
|
102
|
Unable to mount volume
|
103
|
Unable to dismount volume
|
104
|
Unable to start portable mode |
105
|
Unable to stop portable mode |
Examples
Mounting a FreeOTFE volume:
FreeOTFE.exe /mount /volume "C:\My Private Data\my encrypted volume.dat" /freeotfe
Mounting a Linux volume readonly:
FreeOTFE.exe /mount /volume "C:\My Private Data\my encrypted volume.dat" /linux /readonly
Mounting a FreeOTFE partition::
FreeOTFE.exe /mount /volume "\Device\Harddisk0\Partition1" /freeotfe /readonly
Dismount drive "S:":
FreeOTFE.exe /dismount S:
Dismount all volumes, emergency:
FreeOTFE.exe /dismount all /force
Start and stop portable mode:
FreeOTFE.exe /portable start
FreeOTFE.exe /portable stop
PDA Version
Synposis
FreeOTFE4PDA.exe /mount /volume [/keyfile ]
[/password ] [/mountpoint ] [/freeotfe]
[/readonly] [/offset ] [/nocdbatoffset]
[/keyiterations ] [/saltlength ]
FreeOTFE4PDA.exe /dismount { | all} [/force]
Description
FreeOTFE supports a number of command line options that allow a number
of it's 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.
Important: Any mountpoints or filenames with spaces in them must be enclosed in double quotes (").
/dismount {<mountpoint> | all}
|
Dismount indicated volume/all mounted volumes. |
/force
|
When dismounting, force dismount (emergency dismount) |
/freeotfe
|
The specified volume is a FreeOTFE volume. At time of writing, this parameter has no effect
|
/keyfile <keyfile>
|
The keyfile to be used. If specified, this must be set to the full path and filename of the keyfile.
|
/keyiterations <keyiterations>
|
The number of key iterations
|
/mount
|
Mount indicated file/partition |
/mountpoint <mountpoint>
|
The mountpoint where the volume is to appear. |
/nocdbatoffset
|
Indicates that there is no CDB
at the offset with the volume. This paramter has no effect unless the
"/keyfile" parameter is specified
|
/offset <offset>
|
The offset within the file (in bytes)
|
/password <password>
|
The
password to be used. It is not recommended that this is used;
particularly in shortcuts, as this would involve storing your password
in plaintext such that anyone can read it!
|
/readonly
|
Mount the volume readonly
|
/saltlength <saltlength>
|
The length of the salt (in bits)
|
/volume <volume>
|
The volume filename/partition to
be used. This should be set to the full path
and filename of a volume file.
|
Exit Codes
When run at the command line, FreeOTFE will terminate with one of the following exit codes:
Exit code
|
Meaning
|
0 |
Success
|
100
|
Invalid/unrecognised command line
|
101
|
n/a
|
102
|
Unable to mount volume
|
103
|
Unable to dismount volume
|
104
|
n/a |
105
|
n/a |
Examples
Mounting a FreeOTFE volume:
FreeOTFE4PDA.exe /mount /volume "\Storage Card\my encrypted volume.dat"
Dismount volume mounted at "\FreeOTFE secure":
FreeOTFE4PDA.exe /dismount "FreeOTFE secure"
Dismount all volumes, emergency:
FreeOTFE4PDA.exe /dismount all /force
|