Changeset 1437 for trunk/yat/utility/OptionHelp.h
- Timestamp:
- Aug 25, 2008, 7:55:00 PM (14 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/yat/utility/OptionHelp.h
r1275 r1437 8 8 Copyright (C) 2008 Peter Johansson 9 9 10 This file is part of the yat library, http:// trac.thep.lu.se/yat10 This file is part of the yat library, http://dev.thep.lu.se/yat 11 11 12 12 The yat library is free software; you can redistribute it and/or … … 39 39 40 40 When this option is found in parsing of commandline, it displays 41 a help output exits. 41 a help output and exits. A typical output looks like: 42 43 \verbatim 44 Usage: foo [OPTION]... 45 46 SYNOPSIS 47 48 Available options are: 49 -h, --help display this help and exit 50 -v, --verbose explain what is being done 51 52 Some extra information explaining something. 53 \endverbatim 54 55 The output consist of four blocks. The first block can be 56 modified with usage(void) function. The second is block is 57 typically a one-liner explaining the application and can be 58 modified with the synopsis(void) function. The third block 59 contain the description of the different options, see 60 operator<<(std::ostream&, const CommandLine&) for further 61 details. The last block can be modified with post_arguments(void) 62 function. 42 63 */ 43 64 class OptionHelp : public OptionSwitch
Note: See TracChangeset
for help on using the changeset viewer.