UserInterface/use [ Variables ]
NAME
use -- usage string
FUNCTION
Inform the user how to use ROBODoc.
AUTHOR
Koessi
SOURCE
char use[] = // 1 2 3 4 5 6 7 8 // 12345678901234567890123456789012345678901234567890123456789012345678901234567890 "ROBODoc Version " VERSION " autodocs formatter ($Revision: 1.110 $)\n" "(c) 1994-2008 Frans Slothouber, Petteri Kettunen, \n" " Gergely Budai and Jacco van Weert\n" "ROBODoc comes with ABSOLUTELY NO WARRANTY.\n" "This is free software, and you are welcome to redistribute it\n" "under certain conditions; type `robodoc -c' for details.\n" "\n"; char use_usage[] = "Usage:\n" " robodoc --src <directory> --doc <directory> --multidoc [type] [options]\n" " robodoc --src <directory> --doc <file> --singledoc [type] [options]\n" " robodoc --src <file> --doc <file> --singlefile [type] [options]\n" "\n" "Type:\n" " --html, --rtf, --latex, --ascii, --dbxml, --troff\n" "\n"; char use_options1[] = "Options:\n" " --charset NAME Add character encoding information (html only).\n" " --cmode Use ANSI C grammar in source items (html only).\n" " --css Specify the stylesheet to use.\n" " --ext EXTENSION Set extension for generated files.\n" " --footless Do not create the foot of a document.\n" " --headless Do not create the head of a document.\n" " --index Add an index.\n"; char use_options2[] = " --internal Also include internal headers.\n" " --internalonly Only include internal headers.\n" " --lock Recognize only one header marker per file.\n" " --nodesc Do not descent into subdirectories.\n" " --no_subdirectories\n" " Do no create documentation subdirectories.\n" " --nopre Do not use <PRE> </PRE> in the HTML output.\n" " --nosort Do not sort the headers.\n" " --nosource Do not include SOURCE items.\n" " --nogeneratedwith\n" " Do not add the 'generated by robodoc' message\n" " at the top of each documentation file.\n" " --ignore_case_when_linking\n" " Ignore the case of the symbols when trying\n" " to create crosslinks.\n"; char use_options3[] = " --rc Specify an alternate configuration file.\n" " --sections Add sections and subsections.\n" " --first_section_level NUMBER\n" " Start the first section not at 1 but at \n" " level NUMBER.\n" " --tabsize NUMBER Set the tab size.\n" " --tabstops a,b,..,n\n" " Set TAB stops \n" " --tell ROBODoc will tell you what it is doing.\n" " --debug same as --tell, but with lots more details.\n" " --toc Add a table of contents.\n" " --version Print version info and exit.\n" " --sectionnameonly\n" " Generate section header with name only.\n" " --compress Only supported by TROFF output format. Defines by which\n" " program manpages will be compressed. Either bzip2 or gzip.\n" " --mansection Manual section where pages will be inserted (default: 3).\n" " --documenttitle TITLE\n" " Set the document title\n" " --altlatex Alternate LaTeX file format (bigger / clearer than normal)\n" " --latexparts Make the first module level as PART in LaTeX output\n" " --syntaxcolors Turn on all syntax highlighting features in SOURCE items\n" " (html only)\n" " --syntaxcolors_enable quotes,squotes,line_comments,block_comments,\n" " keywords,non_alpha\n" " Enable only specific syntax highlighting features in\n" " SOURCE items (html only)\n" " --dotname NAME Specify the name (and path / options) of DOT tool\n" " --masterindex title,filename\n" " Specify the tile and filename for master index page\n" " --sourceindex title,filename\n" " Specify the tile and filename for source files index page\n" " --one_file_per_header\n" " Create a separate documentation file for each header\n" " --header_breaks NUMBER\n" " Insert a linebreak after every NUMBER header names\n" " (default value: 2, set to zero to disable)\n" " --source_line_numbers\n" " Display original source line numbers for SOURCE items\n" "\n"; char use_authors[] = "Authors/Contributors:\n" " Frans Slothouber, Jacco van Weert, Petteri Kettunen, Bernd Koesling,\n" " Thomas Aglassinger, Anthon Pang, Stefan Kost, David Druffner, Sasha Vasko,\n" " Kai Hofmann, Thierry Pierron, Friedrich Haase, Gergely Budai.\n";