Improve CLI usage line and README

This commit is contained in:
Sebastian Messmer 2016-02-15 02:40:56 +01:00
parent 836858b275
commit 5651a86b78
2 changed files with 5 additions and 4 deletions

View File

@ -44,6 +44,7 @@ Building from source
Requirements Requirements
------------ ------------
- Git (for getting the source code)
- GCC version >= 4.8 or Clang >= 3.5 - GCC version >= 4.8 or Clang >= 3.5
- CMake version >= 2.8 - CMake version >= 2.8
- libcurl4 (including development headers) - libcurl4 (including development headers)
@ -61,7 +62,7 @@ Requirements
You can use the following commands to install these requirements You can use the following commands to install these requirements
# Ubuntu # Ubuntu
$ sudo apt-get install g++ cmake libcurl4-openssl-dev libboost-filesystem-dev libboost-system-dev libboost-chrono-dev libboost-program-options-dev libboost-thread-dev libcrypto++-dev libssl-dev libfuse-dev python $ sudo apt-get install git g++ cmake libcurl4-openssl-dev libboost-filesystem-dev libboost-system-dev libboost-chrono-dev libboost-program-options-dev libboost-thread-dev libcrypto++-dev libssl-dev libfuse-dev python
# Fedora # Fedora
TODO TODO
@ -88,8 +89,8 @@ Build & Install
$ sudo make install $ sudo make install
You can pass the following variables to CMake (using *-Dvariablename=value*): You can pass the following variables to CMake (using *-Dvariablename=value*):
- -D**CMAKE_BUILD_TYPE**=[Release|Debug]: Whether to run code optimization or add debug symbols - -D**CMAKE_BUILD_TYPE**=[Release|Debug]: Whether to run code optimization or add debug symbols. Default: Release
- -D**BUILD_TESTING**=[on|off]: Whether to build the test cases (can take a long time) - -D**BUILD_TESTING**=[on|off]: Whether to build the test cases (can take a long time). Default: off
On most systems, CMake should find the libraries automatically. On most systems, CMake should find the libraries automatically.
If this doesn't work for you, you can use the following CMake variables: If this doesn't work for you, you can use the following CMake variables:

View File

@ -134,7 +134,7 @@ void Parser::_addPositionalOptionForBaseDir(po::options_description *desc, po::p
} }
[[noreturn]] void Parser::_showHelpAndExit() { [[noreturn]] void Parser::_showHelpAndExit() {
cerr << "Usage: cryfs [options] rootDir mountPoint [-- [FUSE Mount Options]]\n"; cerr << "Usage: cryfs [options] baseDir mountPoint [-- [FUSE Mount Options]]\n";
po::options_description desc; po::options_description desc;
_addAllowedOptions(&desc); _addAllowedOptions(&desc);
cerr << desc << endl; cerr << desc << endl;