ACHTUNG: AS OF 20110523, THIS PAGE IS NOW MAINTAINED IN THE NEW WIKI: http://whiki.wanderinghorse.net/wikis/whio/?page=whio_epfs_tools
See also: whio_epfs
whio_epfs ToolsThe source tree comes with several tools for working with whio_epfs container files:
- whio-epfs-mkfs creates EFS container files.
- whio-epfs-ls lists the contents of a EFS container.
- whio-epfs-cp imports files into or exports them from an EFS.
- whio-epfs-rm removes files from an EFS.
- whio-epfs-touch modifies timestamps of EFS entries.
- whio-epfs-label gets or sets an EFS label.
- whio-epfs-lock is a tool to assist in testing EFS file locking.
These tools primarily assist in the development and testing of whio_epfs, but are useful as examples of using the library and for building/maintaining EPFS built as part of a custom project. Some of them rely on private API routines which most client code won't have access to, but over time (and with client-side experience) the public API will be fleshed out so that client-side tools will have the level of access they would need to implement features like those these tools provide. That said, most of the features these tools implement use only the public API.
Common command arguments
All (or most) of the EFS tools listed above support the following general-purpose arguments:
- -? or --help = Show app help and quit.
- -v or --verbose= Enable verbose mode
- -V or --version = Show version information and quit.
- --no-locking disables any file locking (if it was is compiled in to the library). Use with care: with this flag set, whio-epfs-mkfs can destroy an opened EFS.
and most of the tools support the following debugging-related arguments:
- --no-mempool will disable the use of the default fs-internal memory pool (if it was enabled at compile-time).
- --mempool-size=uint32 dynamically allocates a memory pool of the given size. If the size is smaller than some compile-time constant (probably a couple of kb) then a statically-allocated area of memory is used. If the size is 0, the effect is the same as --no-mempool.
(Exception: whio-epfs-mkfs cannot use a memory pool, for very boring reasons which i have forgotten at the moment.)
The tools also require (except in a small handful of cases) that an EFS file be given as the first non-flag argument on the command line. "Non-flag" means an argument which does not start with '-' or '--'.
Regarding the memory pool options: see whio_epfs_mempool.