Commit 017a9051 authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum
Browse files

[ADD] - added manual pages.

parent 27adcd1f
......@@ -86,6 +86,8 @@ SET( OW_CONFIG_DIR_RELATIVE "share/openwalnut" )
SET( OW_CONFIG_DIR ${PROJECT_BINARY_DIR}/${OW_CONFIG_DIR_RELATIVE} )
SET( OW_SHARE_DIR_RELATIVE "share/openwalnut" )
SET( OW_SHARE_DIR ${PROJECT_BINARY_DIR}/${OW_SHARE_DIR_RELATIVE} )
SET( OW_MAN_DIR_RELATIVE "share/man" )
SET( OW_MAN_DIR "${PROJECT_BINARY_DIR}/share/man" )
SET( OW_DOC_DIR_RELATIVE "share/doc/openwalnut" )
SET( OW_DOC_DIR ${PROJECT_BINARY_DIR}/${OW_DOC_DIR_RELATIVE} )
SET( OW_RUNTIME_DIR_RELATIVE "bin" )
......@@ -277,8 +279,9 @@ ADD_CUSTOM_TARGET( vtest
# ---------------------------------------------------------------------------------------------------------------------------------------------------
#
# Resource Copy
# Resource/Doc Copy
# - This simply copies the structure from ../resources to the build directory
# - Additonaly takes care that the user doc and manual pages get placed where they belong.
#
# ---------------------------------------------------------------------------------------------------------------------------------------------------
......@@ -296,6 +299,10 @@ SETUP_ADDITIONAL_DIRECTORY( ${OW_DOC_DIR_RELATIVE}
${PROJECT_SOURCE_DIR}/../doc/user/
TRUE # this denotes that the contents of doc/user should be copied instead of user directly
)
SETUP_ADDITIONAL_DIRECTORY( ${OW_MAN_DIR_RELATIVE}
${PROJECT_SOURCE_DIR}/../doc/man/
TRUE # this denotes that the contents of doc/man should be copied instead of user directly
)
# ---------------------------------------------------------------------------------------------------------------------------------------------------
#
......
......@@ -79,6 +79,8 @@ int main( int argc, char** argv )
namespace po = boost::program_options; // since the namespace is far to big we use a shortcut here
po::options_description desc( "Options:" );
// NOTE: if you modify this, also modify the manual pages! (use help2man or do it manually) But be careful. There need
// to be several manual changes to be done in the manual after help2man has done its job.
desc.add_options()
( "help,h", "Prints this help message" )
( "version,v", "Prints the version information" )
......@@ -106,7 +108,8 @@ int main( int argc, char** argv )
// print usage information if command line asks for help.
if( optionsMap.count( "help" ) )
{
// NOTE: if you modify this, check that help2man still works properly! (http://www.gnu.org/software/help2man)
// NOTE: if you modify this, check that help2man still works properly! (http://www.gnu.org/software/help2man) But be careful. There need
// to be several manual changes to be done in the manual after help2man has done its job.
std::cout << "OpenWalnut is an highly expansible visualization system with focus on brain- and neurological data." << std::endl
<< std::endl
<< "Usage: openwalnut [OPTION]... [FILE]..." << std::endl
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment