From 70322077d21ae38bbe503d88e9e4d73ec883a493 Mon Sep 17 00:00:00 2001 From: Grissiom Date: Sat, 18 Sep 2010 10:18:26 +0800 Subject: [PATCH] remove trialing spaces #2 --- Doxyfile | 910 ++++++++--------- Doxyfile.help.in | 936 +++++++++--------- Doxyfile.user | 66 +- INSTALL | 2 +- Makefile.in | 80 +- configure.ac | 126 +-- doc_src/alias.txt | 2 +- doc_src/begin.txt | 2 +- doc_src/commandline.txt | 6 +- doc_src/commands.hdr.in | 2 +- doc_src/design.hdr | 14 +- doc_src/dirh.txt | 2 +- doc_src/dirs.txt | 2 +- doc_src/else.txt | 2 +- doc_src/emit.txt | 2 +- doc_src/faq.hdr | 18 +- doc_src/for.txt | 4 +- doc_src/functions.txt | 2 +- doc_src/if.txt | 4 +- doc_src/index.hdr.in | 90 +- doc_src/license.hdr | 6 +- doc_src/math.txt | 2 +- doc_src/mimedb.txt | 2 +- doc_src/not.txt | 2 +- doc_src/popd.txt | 4 +- doc_src/prevd.txt | 2 +- doc_src/pushd.txt | 2 +- doc_src/random.txt | 2 +- doc_src/read.txt | 4 +- doc_src/return.txt | 2 +- doc_src/set_color.txt | 4 +- doc_src/source.txt | 2 +- doc_src/ulimit.txt | 2 +- doc_src/vared.txt | 4 +- etc/config.fish.in | 2 +- fish.spec.in | 10 +- install-sh | 16 +- make_completions.py | 20 +- make_vcs_completions.fish | 26 +- po/en.po | 10 +- seq.in | 4 +- share/completions/adduser.fish | 2 +- share/completions/arp.fish | 2 +- share/completions/at.fish | 2 +- share/completions/bind.fish | 2 +- share/completions/bunzip2.fish | 4 +- share/completions/bzcat.fish | 4 +- share/completions/bzip2.fish | 4 +- share/completions/bzip2recover.fish | 4 +- share/completions/cdrecord.fish | 4 +- share/completions/configure.fish | 2 +- share/completions/df.fish | 2 +- share/completions/find.fish | 8 +- share/completions/flac.fish | 2 +- share/completions/git.fish | 2 +- share/completions/gpg.fish | 14 +- share/completions/gprof.fish | 2 +- share/completions/gzip.fish | 2 +- share/completions/kill.fish | 6 +- share/completions/make.fish | 2 +- share/completions/modprobe.fish | 2 +- share/completions/mplayer.fish | 18 +- share/completions/pacman.fish | 8 +- share/completions/ping.fish | 2 +- share/completions/quilt.fish | 2 +- share/completions/scons.fish | 4 +- share/completions/sed.fish | 4 +- share/completions/set.fish | 8 +- share/completions/status.fish | 2 +- share/completions/su.fish | 2 +- share/completions/unrar.fish | 6 +- share/completions/xargs.fish | 6 +- share/completions/xprop.fish | 2 +- share/completions/yum.fish | 28 +- share/config.fish.in | 20 +- share/functions/__fish_append.fish | 2 +- share/functions/__fish_bind_test1.fish | 4 +- share/functions/__fish_bind_test2.fish | 2 +- share/functions/__fish_commandline_test.fish | 4 +- .../__fish_complete_ant_targets.fish | 2 +- share/functions/__fish_complete_cd.fish | 6 +- share/functions/__fish_complete_file_url.fish | 2 +- share/functions/__fish_complete_ls.fish | 28 +- share/functions/__fish_complete_man.fish | 6 +- .../functions/__fish_complete_subcommand.fish | 2 +- .../__fish_complete_subcommand_root.fish | 2 +- share/functions/__fish_complete_suffix.fish | 6 +- share/functions/__fish_complete_tar.fish | 6 +- share/functions/__fish_complete_unrar.fish | 2 +- share/functions/__fish_complete_vi.fish | 6 +- .../functions/__fish_config_interactive.fish | 28 +- share/functions/__fish_contains_opt.fish | 10 +- share/functions/__fish_crux_packages.fish | 2 +- share/functions/__fish_gnu_complete.fish | 6 +- share/functions/__fish_move_last.fish | 6 +- share/functions/__fish_no_arguments.fish | 2 +- share/functions/__fish_not_contain_opt.fish | 10 +- share/functions/__fish_paginate.fish | 2 +- share/functions/__fish_print_filesystems.fish | 6 +- share/functions/__fish_print_help.fish | 2 +- share/functions/__fish_print_packages.fish | 8 +- share/functions/__fish_prt_use_package.fish | 2 +- share/functions/cd.fish | 2 +- share/functions/dirh.fish | 4 +- share/functions/down-or-search.fish | 4 +- .../functions/fish_default_key_bindings.fish | 26 +- share/functions/funced.fish | 8 +- share/functions/grep.fish | 4 +- share/functions/help.fish | 6 +- share/functions/isatty.fish | 4 +- share/functions/math.fish | 2 +- share/functions/nextd.fish | 4 +- share/functions/prevd.fish | 4 +- share/functions/prompt_pwd.fish | 2 +- share/functions/psub.fish | 6 +- share/functions/pwd.fish | 2 +- share/functions/trap.fish | 20 +- share/functions/type.fish | 10 +- share/functions/umask.fish | 14 +- share/functions/up-or-search.fish | 4 +- tests/gen_output.fish | 2 +- tests/test.fish | 2 +- tests/test1.in | 10 +- tests/test2.in | 2 +- tests/test3.in | 6 +- tests/test4.in | 12 +- user_doc.head.html | 6 +- 127 files changed, 1457 insertions(+), 1457 deletions(-) diff --git a/Doxyfile b/Doxyfile index 29524351a..d25badb90 100644 --- a/Doxyfile +++ b/Doxyfile @@ -14,181 +14,181 @@ # Project related configuration options #--------------------------------------------------------------------------- -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = fish -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = 1 -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = doc -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of source -# files, where putting all generated files in the same directory would otherwise +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of source +# files, where putting all generated files in the same directory would otherwise # cause performance problems for the file system. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, # Swedish, and Ukrainian. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is used -# as the annotated text. Otherwise, the brief description is used as-is. If left -# blank, the following values are used ("$name" is automatically replaced with the -# name of the entity): "The $name class" "The $name widget" "The $name file" +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" ABBREVIATE_BRIEF = YES -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited -# members of a class in the documentation of that class as if those members were -# ordinary class members. Constructors, destructors and assignment operators of +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of # the base classes will not be shown. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = +STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an # explicit @brief command for a brief description. JAVADOC_AUTOBRIEF = YES -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member +# If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources -# only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes # will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES @@ -197,168 +197,168 @@ SUBGROUPING = YES # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. SHOW_DIRECTORIES = YES @@ -367,134 +367,134 @@ SHOW_DIRECTORIES = YES # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the # warning originated and the warning text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = +INPUT = -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm -FILE_PATTERNS = *.h *.c +FILE_PATTERNS = *.h *.c -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = NO -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = print_help.c xdgmimealias.c xdgmimealias.h xdgmime.c xdgmimeglob.c xdgmimeglob.h xdgmime.h xdgmimeint.c xdgmimeint.h xdgmimemagic.c xdgmimemagic.h xdgmimeparent.c xdgmimeparent.h -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories # that are symbolic links (a Unix filesystem feature) are excluded from the input. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left # blank all files are included. -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO @@ -503,38 +503,38 @@ FILTER_SOURCE_FILES = NO # configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES @@ -543,133 +543,133 @@ VERBATIM_HEADERS = YES # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = +HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = +HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = +HTML_STYLESHEET = -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [1..20]) +# This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. GENERATE_TREEVIEW = NO -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 @@ -678,74 +678,74 @@ TREEVIEW_WIDTH = 250 # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = YES -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! -LATEX_HEADER = +LATEX_HEADER = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO @@ -754,68 +754,68 @@ LATEX_HIDE_INDICES = NO # configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO @@ -824,33 +824,33 @@ MAN_LINKS = NO # configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_SCHEMA = +XML_SCHEMA = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_DTD = +XML_DTD = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES @@ -859,10 +859,10 @@ XML_PROGRAMLISTING = YES # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO @@ -871,266 +871,266 @@ GENERATE_AUTOGEN_DEF = NO # configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_PREDEFINED tags. EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = +INCLUDE_PATH = -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = +PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse the +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the # parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen +# If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or -# super classes. Setting the tag to NO turns the diagrams off. Note that this -# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is # recommended to install and use dot, since it yields more powerful graphs. CLASS_DIAGRAMS = YES -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = YES -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = NO -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected # functions only using the \callgraph command. CALL_GRAPH = NO -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found on the path. -DOT_PATH = +DOT_PATH = -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the # \dotfile command). -DOTFILE_DIRS = +DOTFILE_DIRS = -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes that -# lay further from the root node will be omitted. Note that setting this option to -# 1 or 2 may greatly reduce the computation time needed for large code bases. Also -# note that a graph may be further truncated if the graph's image dimensions are -# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). # If 0 is used for the depth value (the default), the graph is not depth-constrained. MAX_DOT_GRAPH_DEPTH = 0 -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- -# The SEARCHENGINE tag specifies whether or not a search engine should be +# The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO diff --git a/Doxyfile.help.in b/Doxyfile.help.in index b300477b9..f5ed20c6a 100644 --- a/Doxyfile.help.in +++ b/Doxyfile.help.in @@ -14,191 +14,191 @@ # Project related configuration options #--------------------------------------------------------------------------- -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = fish -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = @PACKAGE_VERSION@ -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = help_doc -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of source -# files, where putting all generated files in the same directory would otherwise +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of source +# files, where putting all generated files in the same directory would otherwise # cause performance problems for the file system. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, # Swedish, and Ukrainian. OUTPUT_LANGUAGE = English -# This tag can be used to specify the encoding used in the generated output. -# The encoding is not always determined by the language that is chosen, -# but also whether or not the output is meant for Windows or non-Windows users. -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES -# forces the Windows encoding (this is the default for the Windows binary), -# whereas setting the tag to NO uses a Unix-style encoding (the default for +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for # all platforms other than Windows). USE_WINDOWS_ENCODING = NO -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is used -# as the annotated text. Otherwise, the brief description is used as-is. If left -# blank, the following values are used ("$name" is automatically replaced with the -# name of the entity): "The $name class" "The $name widget" "The $name file" +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" ABBREVIATE_BRIEF = YES -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited -# members of a class in the documentation of that class as if those members were -# ordinary class members. Constructors, destructors and assignment operators of +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of # the base classes will not be shown. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = +STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an # explicit @brief command for a brief description. JAVADOC_AUTOBRIEF = YES -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member +# If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources -# only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes # will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES @@ -207,168 +207,168 @@ SUBGROUPING = YES # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. SHOW_DIRECTORIES = YES @@ -377,133 +377,133 @@ SHOW_DIRECTORIES = YES # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the # warning originated and the warning text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = doc_src -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm FILE_PATTERNS = *.doxygen -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = NO -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories # that are symbolic links (a Unix filesystem feature) are excluded from the input. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left # blank all files are included. -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO @@ -512,38 +512,38 @@ FILTER_SOURCE_FILES = NO # configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES @@ -552,133 +552,133 @@ VERBATIM_HEADERS = YES # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = NO -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = +HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = +HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = +HTML_STYLESHEET = -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [1..20]) +# This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. GENERATE_TREEVIEW = NO -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 @@ -687,74 +687,74 @@ TREEVIEW_WIDTH = 250 # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! -LATEX_HEADER = +LATEX_HEADER = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO @@ -763,68 +763,68 @@ LATEX_HIDE_INDICES = NO # configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = YES -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .1 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = YES @@ -833,33 +833,33 @@ MAN_LINKS = YES # configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_SCHEMA = +XML_SCHEMA = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_DTD = +XML_DTD = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES @@ -868,10 +868,10 @@ XML_PROGRAMLISTING = YES # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO @@ -880,282 +880,282 @@ GENERATE_AUTOGEN_DEF = NO # configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_PREDEFINED tags. EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = +INCLUDE_PATH = -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = +PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse the +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the # parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen +# If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or -# super classes. Setting the tag to NO turns the diagrams off. Note that this -# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is # recommended to install and use dot, since it yields more powerful graphs. CLASS_DIAGRAMS = YES -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = NO -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected # functions only using the \callgraph command. CALL_GRAPH = NO -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found on the path. -DOT_PATH = +DOT_PATH = -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the # \dotfile command). -DOTFILE_DIRS = +DOTFILE_DIRS = -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_WIDTH = 1024 -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_HEIGHT = 1024 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes that -# lay further from the root node will be omitted. Note that setting this option to -# 1 or 2 may greatly reduce the computation time needed for large code bases. Also -# note that a graph may be further truncated if the graph's image dimensions are -# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). # If 0 is used for the depth value (the default), the graph is not depth-constrained. MAX_DOT_GRAPH_DEPTH = 0 -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- -# The SEARCHENGINE tag specifies whether or not a search engine should be +# The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO diff --git a/Doxyfile.user b/Doxyfile.user index f6acde7e0..99927595b 100644 --- a/Doxyfile.user +++ b/Doxyfile.user @@ -10,8 +10,8 @@ ABBREVIATE_BRIEF = YES ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = YES -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = NO @@ -19,7 +19,7 @@ DETAILS_AT_TOP = NO INHERIT_DOCS = YES DISTRIBUTE_GROUP_DOC = NO TAB_SIZE = 8 -ALIASES = +ALIASES = OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_JAVA = NO SUBGROUPING = YES @@ -44,7 +44,7 @@ GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = +ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES SHOW_DIRECTORIES = YES @@ -53,19 +53,19 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = -INPUT = +WARN_LOGFILE = +INPUT = FILE_PATTERNS = doc.h RECURSIVE = NO -EXCLUDE = +EXCLUDE = EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO SOURCE_BROWSER = NO INLINE_SOURCES = NO @@ -75,17 +75,17 @@ REFERENCES_RELATION = YES VERBATIM_HEADERS = YES ALPHABETICAL_INDEX = NO COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = +IGNORE_PREFIX = GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_HEADER = user_doc.head.html -HTML_FOOTER = -HTML_STYLESHEET = +HTML_FOOTER = +HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = +CHM_FILE = +HHC_LOCATION = GENERATE_CHI = NO BINARY_TOC = NO TOC_EXPAND = NO @@ -99,8 +99,8 @@ LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = +EXTRA_PACKAGES = +LATEX_HEADER = PDF_HYPERLINKS = YES USE_PDFLATEX = YES LATEX_BATCHMODE = NO @@ -109,33 +109,33 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf COMPACT_RTF = NO RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = GENERATE_MAN = NO MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO GENERATE_XML = NO XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = +XML_SCHEMA = +XML_DTD = XML_PROGRAMLISTING = YES GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO PERLMOD_LATEX = NO PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES -TAGFILES = -GENERATE_TAGFILE = +TAGFILES = +GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl @@ -151,8 +151,8 @@ INCLUDED_BY_GRAPH = YES CALL_GRAPH = YES GRAPHICAL_HIERARCHY = YES DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = +DOT_PATH = +DOTFILE_DIRS = MAX_DOT_GRAPH_WIDTH = 750 MAX_DOT_GRAPH_HEIGHT = 1024 MAX_DOT_GRAPH_DEPTH = 0 diff --git a/INSTALL b/INSTALL index fefe0404e..3a039fb21 100644 --- a/INSTALL +++ b/INSTALL @@ -49,7 +49,7 @@ Then, use following commands to compile fish: Finally, if you wish to use fish as your default shell, use the following command: - % chsh -s /usr/local/bin/fish + % chsh -s /usr/local/bin/fish chsh will prompt you for your password, and change your default shell. diff --git a/Makefile.in b/Makefile.in index 71bf277a8..7e1c664d3 100644 --- a/Makefile.in +++ b/Makefile.in @@ -53,16 +53,16 @@ sysconfdir = @sysconfdir@ docdir = @docdir@ localedir = @localedir@ prefix = @prefix@ -optbindirs = @optbindirs@ +optbindirs = @optbindirs@ # # Various flags # -MACROS = -DLOCALEDIR=\"$(localedir)\" -DPREFIX=L\"$(prefix)\" -DDATADIR=L\"$(datadir)\" -DSYSCONFDIR=L\"$(sysconfdir)\" -CFLAGS = @CFLAGS@ $(MACROS) -CPPFLAGS = @CPPFLAGS@ -LDFLAGS = @LIBS@ @LDFLAGS@ +MACROS = -DLOCALEDIR=\"$(localedir)\" -DPREFIX=L\"$(prefix)\" -DDATADIR=L\"$(datadir)\" -DSYSCONFDIR=L\"$(sysconfdir)\" +CFLAGS = @CFLAGS@ $(MACROS) +CPPFLAGS = @CPPFLAGS@ +LDFLAGS = @LIBS@ @LDFLAGS@ LDFLAGS_FISH = ${LDFLAGS} @LIBS_FISH@ @LDFLAGS_FISH@ LDFLAGS_FISH_INDENT = ${LDFLAGS} @LIBS_FISH_INDENT@ LDFLAGS_FISH_PAGER = ${LDFLAGS} @LIBS_FISH_PAGER@ @@ -158,7 +158,7 @@ HDR_FILES_SRC := doc_src/index.hdr.in doc_src/commands.hdr.in doc_src/design.hdr HDR_FILES := $(subst .hdr.in,.hdr,$(HDR_FILES_SRC)) # -# Files containing documentation for external commands. +# Files containing documentation for external commands. # HELP_SRC := $(wildcard doc_src/*.txt) @@ -208,7 +208,7 @@ MAIN_DIR_FILES := $(sort $(MAIN_DIR_FILES_UNSORTED)) # Files in ./etc/ # -ETC_DIR_FILES :=etc/config.fish.in +ETC_DIR_FILES :=etc/config.fish.in # @@ -245,7 +245,7 @@ FUNCTIONS_DIR_FILES := $(wildcard share/functions/*.fish) # SIMPLE_PROGRAMS := fish set_color mimedb fish_pager fishd fish_indent -PROGRAMS := $(SIMPLE_PROGRAMS) @XSEL@ @SEQ_FALLBACK@ +PROGRAMS := $(SIMPLE_PROGRAMS) @XSEL@ @SEQ_FALLBACK@ # @@ -269,7 +269,7 @@ TRANSLATIONS := $(TRANSLATIONS_SRC:.po=.gmo) # all: $(PROGRAMS) user_doc share/man etc/config.fish share/config.fish $(TRANSLATIONS) - @echo fish has now been built. + @echo fish has now been built. @echo Use \'$(MAKE) install\' to install fish. .PHONY: all @@ -300,7 +300,7 @@ debug: # User documentation, describing the features of the fish shell. # -# Depend on the sources (*.hdr.in) and manually make the +# Depend on the sources (*.hdr.in) and manually make the # intermediate *.hdr and doc.h files if needed user_doc: $(HDR_FILES_SRC) Doxyfile.user user_doc.head.html $(HELP_SRC) @@ -313,19 +313,19 @@ user_doc: $(HDR_FILES_SRC) Doxyfile.user user_doc.head.html $(HELP_SRC) # Source code documentation. Also includes user documentation. # -doc: *.h *.c doc.h Doxyfile - doxygen; +doc: *.h *.c doc.h Doxyfile + doxygen; # # PDF version of the source code documentation. # -doc/refman.pdf: doc - cd doc/latex; - make; - mv refman.pdf ..; - cd ../..; +doc/refman.pdf: doc + cd doc/latex; + make; + mv refman.pdf ..; + cd ../..; rm -r doc/latex; @@ -362,7 +362,7 @@ doc_src/commands.hdr:$(HELP_SRC) doc_src/commands.hdr.in echo >>command_list.tmp; \ echo >>command_list.tmp; \ echo "Back to index". >>command_list.tmp; \ - done + done mv command_list.tmp command_list.txt cat $@.in | awk '{if ($$0 ~ /@command_list@/){ system("cat command_list.txt");} else{ print $$0;}}' >$@ @@ -400,19 +400,19 @@ doc.h: $(HDR_FILES) # %.doxygen:%.txt - echo "/** \page " `basename $*` >$@; - cat $*.txt >>$@; + echo "/** \page " `basename $*` >$@; + cat $*.txt >>$@; echo "*/" >>$@ -%: %.in +%: %.in sed <$@.in >$@ \ -e "s,@sysconfdir\@,$(sysconfdir),g" \ -e "s,@datadir\@,$(datadir),g" \ -e "s,@docdir\@,$(docdir),g" \ -e "s|@configure_input\@|$@, generated from $@.in by the Makefile. DO NOT MANUALLY EDIT THIS FILE!|g" \ -e "s,@prefix\@,$(prefix),g" \ - -e "s,@optbindirs\@,$(optbindirs),g" -#-e "s,@\@,$()," + -e "s,@optbindirs\@,$(optbindirs),g" +#-e "s,@\@,$()," # @@ -477,8 +477,8 @@ common.o: $(COMMON_FILES) # (__fish_print_help) # || # \/ -# formated text -# with escape +# formated text +# with escape # sequences # # @@ -500,7 +500,7 @@ share/man: $(HELP_SRC) for i in $(HELP_SRC); do \ CMD_NAME=`basename $$i .txt`; \ sed -e "s/\(.\)\\.SH/\1/" -e "s/$$CMD_NAME *\\\\- *\"\(.*\)\"/\1/" share/man/$$CMD_NAME.1; \ - done + done rm doc_src/*.doxygen # Clean up intermediate files in doc_src/ rm -r help_doc # Clean up intermediate help_doc tree @@ -565,7 +565,7 @@ install: all install-sh check-uninstall install-force # install-force: all install-translations - $(INSTALL) -m 755 -d $(DESTDIR)$(bindir) + $(INSTALL) -m 755 -d $(DESTDIR)$(bindir) for i in $(PROGRAMS); do\ $(INSTALL) -m 755 $$i $(DESTDIR)$(bindir) ; \ done; @@ -595,7 +595,7 @@ install-force: all install-translations for i in $(MANUALS); do \ $(INSTALL) -m 644 $$i $(DESTDIR)$(mandir)/man1/; \ done; - @echo fish is now installed on your system. + @echo fish is now installed on your system. @echo To run fish, type \'fish\' in your terminal. @echo @echo To use fish as your login shell: @@ -652,7 +652,7 @@ uninstall-legacy: uninstall -rmdir $(DESTDIR)$(sysconfdir)/fish.d/completions -rmdir $(DESTDIR)$(sysconfdir)/fish.d -rm $(DESTDIR)$(sysconfdir)/fish - @echo The previous fish installation has been removed. + @echo The previous fish installation has been removed. .PHONY: uninstall-legacy install-translations: $(TRANSLATIONS) @@ -665,7 +665,7 @@ install-translations: $(TRANSLATIONS) fi; .PHONY: install-translations -uninstall-translations: +uninstall-translations: if test $(HAVE_GETTEXT) = 1; then \ for i in $(TRANSLATIONS_SRC); do \ rm -f $(DESTDIR)$(datadir)/locale/*/LC_MESSAGES/fish.mo; \ @@ -682,7 +682,7 @@ uninstall-translations: # Build the fish program. # -fish: $(FISH_OBJS) fish.o +fish: $(FISH_OBJS) fish.o $(CC) $(FISH_OBJS) fish.o $(LDFLAGS_FISH) -o $@ @@ -698,7 +698,7 @@ fish_pager: $(FISH_PAGER_OBJS) # Build the fishd program. # -fishd: $(FISHD_OBJS) +fishd: $(FISHD_OBJS) $(CC) $(FISHD_OBJS) $(LDFLAGS_FISHD) -o $@ @@ -756,7 +756,7 @@ key_reader: key_reader.o input_common.o common.o env_universal.o env_universal_c # Update dependencies # depend: - makedepend -fMakefile.in -Y *.c + makedepend -fMakefile.in -Y *.c ./config.status .PHONY: depend @@ -765,7 +765,7 @@ depend: # an archive from it. Simplest way I could think of to make an archive # witout backups, autogenerated files, etc. # -# Uses install instead of mkdir so build won't fail if the directory +# Uses install instead of mkdir so build won't fail if the directory # exists # @@ -817,7 +817,7 @@ dist: fish-@PACKAGE_VERSION@.tar.bz2 .PHONY: dist # -# Build the RPM spec file. +# Build the RPM spec file. # fish.spec: fish.spec.in @@ -854,7 +854,7 @@ rpm: fish-@PACKAGE_VERSION@.tar.bz2 fish.spec # distclean: clean - rm -f fish.spec Doxyfile.help + rm -f fish.spec Doxyfile.help rm -f etc/config.fish seq share/config.fish rm -f config.status config.log config.h Makefile .PHONY: distclean @@ -868,12 +868,12 @@ distclean: clean clean: rm -f *.o doc.h doc.tmp doc_src/*.doxygen doc_src/*.c doc_src/*.o doc_src/commands.hdr rm -f tests/tmp.err tests/tmp.out tests/tmp.status tests/foo.txt - rm -f $(PROGRAMS) fish_tests tokenizer_test key_reader + rm -f $(PROGRAMS) fish_tests tokenizer_test key_reader rm -f share/config.fish etc/config.fish doc_src/index.hdr doc_src/commands.hdr - rm -f fish-@PACKAGE_VERSION@.tar - rm -f fish-@PACKAGE_VERSION@.tar.gz + rm -f fish-@PACKAGE_VERSION@.tar + rm -f fish-@PACKAGE_VERSION@.tar.gz rm -f fish-@PACKAGE_VERSION@.tar.bz2 - rm -rf doc; + rm -rf doc; rm -rf fish-@PACKAGE_VERSION@ rm -rf xsel-0.9.6/ rm -f $(TRANSLATIONS) diff --git a/configure.ac b/configure.ac index 1d96a0be9..5eb58ca03 100644 --- a/configure.ac +++ b/configure.ac @@ -54,7 +54,7 @@ if test configure -ot configure.ac; then fi exit 1 else - AC_MSG_ERROR( + AC_MSG_ERROR( [cannot find the autoconf program in your path. This program needs to be run whenever the configure.ac file is modified. Please install it and try again.] @@ -79,7 +79,7 @@ if test ! -f ./config.h.in -o config.h.in -ot configure.ac; then AC_MSG_NOTICE([running autoheader]) autoheader || exit 1 else - AC_MSG_ERROR( + AC_MSG_ERROR( [cannot find the autoheader program in your path. This program needs to be run whenever the configure.ac file is modified. Please install it and try again.] @@ -130,7 +130,7 @@ done # -# Tell autoconf to create config.h header +# Tell autoconf to create config.h header # AC_CONFIG_HEADERS(config.h) @@ -144,8 +144,8 @@ AH_BOTTOM([#if __GNUC__ >= 3 #define __warn_unused __attribute__ ((warn_unused_result)) #define __sentinel __attribute__ ((sentinel)) #else -#define __warn_unused -#define __sentinel +#define __warn_unused +#define __sentinel #endif]) @@ -195,14 +195,14 @@ fi # Optionally drop xsel command # -AC_ARG_WITH( - xsel, +AC_ARG_WITH( + xsel, AC_HELP_STRING( [--without-xsel], [do not build the xsel program needed for X clipboard integration] ), [xsel=$withval], - [xsel=with_xsel] + [xsel=with_xsel] ) if [[ "$xsel" = "with_xsel" ]]; then @@ -226,7 +226,7 @@ AC_ARG_WITH( [local_gettext=yes] ) -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_DEFINE([USE_GETTEXT],[1],[Perform string translations with gettext]) fi @@ -338,9 +338,9 @@ AC_RUN_IFELSE( return STATUS; ] ) - ], - [glibc=yes], - [glibc=no] + ], + [glibc=yes], + [glibc=no] ) if test "$glibc" = yes; then @@ -383,7 +383,7 @@ fi AC_MSG_CHECKING([if we are under Solaris]) case $target_os in - solaris*) + solaris*) AC_DEFINE( __EXTENSIONS__, 1, [Macro to enable additional prototypes under Solaris]) AC_MSG_RESULT(yes) ;; @@ -397,7 +397,7 @@ AC_MSG_CHECKING([if we are using non varargs tparm.]) AC_COMPILE_IFELSE( [ AC_LANG_PROGRAM( - [ + [ #include #include ], @@ -406,8 +406,8 @@ AC_COMPILE_IFELSE( ] ) ], - [tparm_solaris_kludge=no], - [tparm_solaris_kludge=yes] + [tparm_solaris_kludge=no], + [tparm_solaris_kludge=yes] ) if test "x$tparm_solaris_kludge" = "xyes"; then AC_MSG_RESULT(yes) @@ -427,7 +427,7 @@ fi AC_MSG_CHECKING([if we are under BSD]) case $target_os in - *bsd*) + *bsd*) AC_DEFINE( __BSD_VISIBLE, 1, [Macro to enable additional prototypes under BSD]) AC_DEFINE( _NETBSD_SOURCE, 1, [Macro to enable additional prototypes under BSD]) AC_MSG_RESULT(yes) @@ -486,7 +486,7 @@ AC_CHECK_FILES([/proc/self/stat]) # AC_DEFINE( - [HAVE_TRANSLATE_H], + [HAVE_TRANSLATE_H], [1], [Define to 1 if the wgettext function should be used for translating strings.] ) @@ -510,12 +510,12 @@ LIBS_SHARED=$LIBS LIBS=$LIBS_COMMON # -# Check for libraries needed by fish. +# Check for libraries needed by fish. # LIBS_COMMON=$LIBS LIBS="$LIBS_SHARED" -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_SEARCH_LIBS( gettext, intl,,) fi @@ -527,24 +527,24 @@ LIBS_FISH=$LIBS LIBS=$LIBS_COMMON # -# Check for libraries needed by fish_indent. +# Check for libraries needed by fish_indent. # LIBS_COMMON=$LIBS LIBS="$LIBS_SHARED" -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_SEARCH_LIBS( gettext, intl,,) fi LIBS_FISH_INDENT=$LIBS LIBS=$LIBS_COMMON # -# Check for libraries needed by fish_pager. +# Check for libraries needed by fish_pager. # LIBS_COMMON=$LIBS LIBS="$LIBS_SHARED" -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_SEARCH_LIBS( gettext, intl,,) fi AC_SEARCH_LIBS( iconv_open, iconv, , [AC_MSG_ERROR([Could not find an iconv implementation, needed to build fish])] ) @@ -552,12 +552,12 @@ LIBS_FISH_PAGER=$LIBS LIBS=$LIBS_COMMON # -# Check for libraries needed by fishd. +# Check for libraries needed by fishd. # LIBS_COMMON=$LIBS LIBS="$LIBS_SHARED" -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_SEARCH_LIBS( gettext, intl,,) fi AC_SEARCH_LIBS( iconv_open, iconv, , [AC_MSG_ERROR([Could not find an iconv implementation, needed to build fish])] ) @@ -565,12 +565,12 @@ LIBS_FISHD=$LIBS LIBS=$LIBS_COMMON # -# Check for libraries needed by mimedb. +# Check for libraries needed by mimedb. # LIBS_COMMON=$LIBS LIBS="$LIBS_SHARED" -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_SEARCH_LIBS( gettext, intl,,) fi LIBS_MIMEDB=$LIBS @@ -578,12 +578,12 @@ LIBS=$LIBS_COMMON # -# Check for libraries needed by set_color +# Check for libraries needed by set_color # LIBS_COMMON=$LIBS LIBS="$LIBS_SHARED" -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_SEARCH_LIBS( gettext, intl,,) fi LIBS_SET_COLOR=$LIBS @@ -599,8 +599,8 @@ AC_CHECK_HEADER( [regex.h], [ AC_DEFINE( - [HAVE_REGEX_H], - [1], + [HAVE_REGEX_H], + [1], [Define to 1 if you have the header file.] ) ], @@ -697,10 +697,10 @@ for i in "" "-D_POSIX_C_SOURCE=200112L" "-D_XOPEN_SOURCE=600 -D_POSIX_C_SOURCE=2 /* Extended-POSIX: might be unhidden by _XOPEN_SOURCE. */ ret += killpg( 0, 0 ); /* Non-standard: might be hidden by the macros. */ - { + { struct winsize termsize; ret += (int)(void *)&termsize; - ret += SIGWINCH + TIOCGWINSZ + SIGIO; + ret += SIGWINCH + TIOCGWINSZ + SIGIO; } return ret; @@ -744,7 +744,7 @@ AC_CHECK_FUNCS( dcgettext backtrace backtrace_symbols sysconf ) # the translations should be installed. # -if test x$local_gettext != xno; then +if test x$local_gettext != xno; then AC_CHECK_FUNC( gettext, HAVE_GETTEXT=1, HAVE_GETTEXT=0 ) fi @@ -768,22 +768,22 @@ AC_RUN_IFELSE( #include ], [ - int status; - char *res; - res = realpath( "somefile", 0 ); - status = !(res != 0 || errno == ENOENT); + int status; + char *res; + res = realpath( "somefile", 0 ); + status = !(res != 0 || errno == ENOENT); exit( status ); ] ) - ], - [have_realpath_null=yes], - [have_realpath_null=no] + ], + [have_realpath_null=yes], + [have_realpath_null=no] ) if test "$have_realpath_null" = yes; then AC_MSG_RESULT(yes) AC_DEFINE( - [HAVE_REALPATH_NULL], + [HAVE_REALPATH_NULL], [1], [Define to 1 if realpath accepts null for its second argument.] ) @@ -810,15 +810,15 @@ AC_LINK_IFELSE( #endif ], [ - struct winsize termsize = {0}; + struct winsize termsize = {0}; TIOCGWINSZ; ] ) - ], + ], [ - AC_MSG_RESULT(yes); + AC_MSG_RESULT(yes); AC_DEFINE([HAVE_WINSIZE], [1], [Define to 1 if the winsize struct and TIOCGWINSZ macro exist]) - ], + ], [ AC_MSG_RESULT(no) ] @@ -854,7 +854,7 @@ if test "$ac_cv_func_fwprintf" = yes; then [ AC_MSG_RESULT([yes]) AC_DEFINE([HAVE_BROKEN_FWPRINTF], [1], [Define to 1 one if the implemented fwprintf is broken]) - ] + ] ) fi @@ -870,19 +870,19 @@ AC_TRY_LINK( ], [ extern int _nl_msg_cat_cntr; - int tmp = _nl_msg_cat_cntr; + int tmp = _nl_msg_cat_cntr; exit(tmp); ], - have__nl_msg_cat_cntr=yes, + have__nl_msg_cat_cntr=yes, have__nl_msg_cat_cntr=no ) if test "$have__nl_msg_cat_cntr" = yes; then AC_MSG_RESULT(yes) AC_DEFINE( - [HAVE__NL_MSG_CAT_CNTR], + [HAVE__NL_MSG_CAT_CNTR], [1], [Define to 1 if the _nl_msg_cat_cntr symbol is exported.] - ) + ) else AC_MSG_RESULT(no) fi @@ -895,19 +895,19 @@ AC_TRY_LINK( ], [ extern char **__environ; - char **tmp = __environ; + char **tmp = __environ; exit(tmp!=0); ], - have___environ=yes, + have___environ=yes, have___environ=no ) if test "$have___environ" = yes; then AC_MSG_RESULT(yes) AC_DEFINE( - [HAVE___ENVIRON], + [HAVE___ENVIRON], [1], [Define to 1 if the __environ symbol is exported.] - ) + ) else AC_MSG_RESULT(no) fi @@ -924,26 +924,26 @@ AC_TRY_LINK( static struct option long_options[] = { - 0, 0, 0, 0 + 0, 0, 0, 0 } ; int opt = getopt_long( 0, - 0, 0, - long_options, + 0, + long_options, 0 ); - + ], - have_working_getopt_long=yes, + have_working_getopt_long=yes, have_working_getopt_long=no ) if test "$have_working_getopt_long" = yes; then AC_MSG_RESULT(yes) AC_DEFINE( - [HAVE_WORKING_GETOPT_LONG], + [HAVE_WORKING_GETOPT_LONG], [1], [Define to 1 if getopt_long exists and works.] - ) + ) else AC_MSG_RESULT(no) fi diff --git a/doc_src/alias.txt b/doc_src/alias.txt index 523e47772..2ab277e9f 100644 --- a/doc_src/alias.txt +++ b/doc_src/alias.txt @@ -12,7 +12,7 @@ shells. For other uses, it is recommended to define a function. Alias does not keep track of which functions have been defined using -alias, nor does it allow erasing of aliases. +alias, nor does it allow erasing of aliases. - NAME is the name of the function to define - DEFINITION is the body of the function. The string " $argv" will be appended to the body. diff --git a/doc_src/begin.txt b/doc_src/begin.txt index b4a822c3b..f5f7f53e0 100644 --- a/doc_src/begin.txt +++ b/doc_src/begin.txt @@ -37,7 +37,7 @@ In the following code, all output is redirected to the file out.html. begin echo $xml_header echo $html_header - if test -e $file + if test -e $file ... end ... diff --git a/doc_src/commandline.txt b/doc_src/commandline.txt index 0202bbb34..df03ab13f 100644 --- a/doc_src/commandline.txt +++ b/doc_src/commandline.txt @@ -13,9 +13,9 @@ The following switches change what the commandline builtin does -- \c -C or \c --cursor set or get the current cursor position, not +- \c -C or \c --cursor set or get the current cursor position, not the contents of the buffer. If no argument is given, the current - cursor position is printed, otherwise the argument is interpreted + cursor position is printed, otherwise the argument is interpreted as the new cursor position. - \c -f or \c --function inject readline functions into the reader. This option can not be combined with any other option. It @@ -44,7 +44,7 @@ or updated - \c -t or \c --current-token select the current token. The following switch changes the way \c commandline prints the current -commandline buffer +commandline buffer - \c -c or \c --cut-at-cursor only print selection up until the current cursor position diff --git a/doc_src/commands.hdr.in b/doc_src/commands.hdr.in index 188d5d8d9..b62a6d568 100644 --- a/doc_src/commands.hdr.in +++ b/doc_src/commands.hdr.in @@ -1,5 +1,5 @@ /** \page commands Commands, functions and builtins bundled with fish -Fish ships with a large number of builtin commands, shellscript functions and external commands. These are all described below. +Fish ships with a large number of builtin commands, shellscript functions and external commands. These are all described below. @command_list@ diff --git a/doc_src/design.hdr b/doc_src/design.hdr index db93fa175..c6fea80a7 100644 --- a/doc_src/design.hdr +++ b/doc_src/design.hdr @@ -7,8 +7,8 @@ design fish. The fish design has three high level goals. These are: -# Everything that can be done in other shell languages should be possible to do in fish, though fish may rely on external commands in -doing so. --# Fish should be user friendly, but not at the expense of expressiveness. +doing so. +-# Fish should be user friendly, but not at the expense of expressiveness. Most tradeoffs between power and ease of use can be avoided with careful design. -# Whenever possible without breaking the above goals, fish should follow the Posix syntax. @@ -33,7 +33,7 @@ program harder to maintain and update. Examples: - Here documents are too similar to using echo inside of a pipeline. -- Subshells, command substitution and process substitution are strongly related. \c fish only supports command substitution, the others can be achived either using a block or the psub shellscript function. +- Subshells, command substitution and process substitution are strongly related. \c fish only supports command substitution, the others can be achived either using a block or the psub shellscript function. - Having both aliases and functions is confusing, especially since both of them have limitations and problems. \c fish functions have none of the drawbacks of either syntax. - The many Posix quoting styles are silly, especially \$''. @@ -57,14 +57,14 @@ take the whole system down. Examples: - Builtin commands should only be created when it cannot be -avoided. \c echo, \c kill, \c printf and \c time are among the commands -that fish does not implement internally since they can be provided as -external commands. Several other commands that are commonly implemented +avoided. \c echo, \c kill, \c printf and \c time are among the commands +that fish does not implement internally since they can be provided as +external commands. Several other commands that are commonly implemented as builtins and can not be implemented as external commands, including \c type, \c vared, \c pushd and \c popd are implemented as shellscript functions in fish. - Mathematical calculations, regex matching, generating lists of numbers -and many other funtions can easily be done in external programs. They +and many other funtions can easily be done in external programs. They should not be supported internally by the shell. The law of minimalism does not imply that a large feature set is diff --git a/doc_src/dirh.txt b/doc_src/dirh.txt index 0a65bdb62..efd4ac79f 100644 --- a/doc_src/dirh.txt +++ b/doc_src/dirh.txt @@ -3,6 +3,6 @@ \subsection dirh-synopsis Synopsis dirh -\subsection dirh-description Description +\subsection dirh-description Description dirh prints the current directory history. The current position in the history is highlighted using $fish_color_history_current. diff --git a/doc_src/dirs.txt b/doc_src/dirs.txt index 0419440ca..b5b9c0aea 100644 --- a/doc_src/dirs.txt +++ b/doc_src/dirs.txt @@ -3,5 +3,5 @@ \subsection dirs-synopsis Synopsis dirs -\subsection dirs-description Description +\subsection dirs-description Description dirs prints the current directory stack. diff --git a/doc_src/else.txt b/doc_src/else.txt index 035abd624..e0f8b85bb 100644 --- a/doc_src/else.txt +++ b/doc_src/else.txt @@ -13,5 +13,5 @@ status is 0, the commands COMMANDS_TRUE will execute. If it is not 0 and The command if test -f foo.txt; echo foo.txt exists; else; echo foo.txt does not exist; end will print foo.txt exists if the file foo.txt -exists and is a regular file, otherwise it will print +exists and is a regular file, otherwise it will print foo.txt does not exist. diff --git a/doc_src/emit.txt b/doc_src/emit.txt index 78d36917c..f28217487 100644 --- a/doc_src/emit.txt +++ b/doc_src/emit.txt @@ -5,7 +5,7 @@ \subsection emit-description Description -The emit builtin fires a generic fish event. Such events can be caught by special functions called event handlers. +The emit builtin fires a generic fish event. Such events can be caught by special functions called event handlers. \subsection emit-example Example diff --git a/doc_src/faq.hdr b/doc_src/faq.hdr index d8058ab1b..0fc746344 100644 --- a/doc_src/faq.hdr +++ b/doc_src/faq.hdr @@ -33,7 +33,7 @@ parent is ~. This issue is not possible to fix without either making every single command into a builtin, breaking Unix semantics or implementing kludges in every single command. -This issue can also be seen when doing IO redirection. +This issue can also be seen when doing IO redirection. Another related issue is that many programs that operate on recursive directory trees, like the find command, silently ignore symlinked @@ -56,7 +56,7 @@ feature, write set CDPATH . on the commandline. If fish is unable to locate a command with a given name, fish will test if a directory of that name exists. If it does, it is implicitly -assumed that you want to change working directory. For example, the +assumed that you want to change working directory. For example, the fastest way to switch to your home directory is to simply press ~ and enter. @@ -141,21 +141,21 @@ set fish_greeting \section faq-history Why doesn't history substitution ("!$" etc.) work? -Because history substitution is an awkward interface that was invented before -interactive line editing was even possible. Fish drops it in favor of -perfecting the interactive history recall interface. Switching requires a -small change of habits: if you want to modify an old line/word, first recall -it, then edit. E.g. don't type "sudo !!" - first press Up, then Home, then +Because history substitution is an awkward interface that was invented before +interactive line editing was even possible. Fish drops it in favor of +perfecting the interactive history recall interface. Switching requires a +small change of habits: if you want to modify an old line/word, first recall +it, then edit. E.g. don't type "sudo !!" - first press Up, then Home, then type "sudo ". Fish history recall is very simple yet effective: - As in any modern shell, the Up arrow recalls whole lines, starting from the last line executed. A single press replaces "!!", later presses replace "!-3" and the like. - - If the line you want is far back in the history, type any part of the line and then press Up one or more times. This will constrain the recall to lines that include this text, and you will get to the line you want much faster. This replaces "!vi", "!?bar.c" and the like. + - If the line you want is far back in the history, type any part of the line and then press Up one or more times. This will constrain the recall to lines that include this text, and you will get to the line you want much faster. This replaces "!vi", "!?bar.c" and the like. - Alt+Up recalls individual arguments, starting from the last argument in the last line executed. A single press replaces "!$", later presses replace "!!:4" and the like. - If the argument you want is far back in history (e.g. 2 lines back - that's a lot of words!), type any part of it and then press Alt+Up. This will show only arguments containing that part and you will get what you want much faster. Try it out, this is very convenient! - If you want to reuse several arguments from the same line ("!!:3*" and the like), consider recalling the whole line and removing what you don't need (Alt+D and Alt+Backspace are your friends). - + See documentation for more details about line editing in fish. */ diff --git a/doc_src/for.txt b/doc_src/for.txt index b4b3dfaf1..2ffffe40a 100644 --- a/doc_src/for.txt +++ b/doc_src/for.txt @@ -11,7 +11,7 @@ not be executed at all. \subsection for-example Example -The command +The command for i in foo bar baz; echo $i; end @@ -21,5 +21,5 @@ would output: foo bar baz - + diff --git a/doc_src/functions.txt b/doc_src/functions.txt index 7643bfc68..4e5d7ddf2 100644 --- a/doc_src/functions.txt +++ b/doc_src/functions.txt @@ -17,7 +17,7 @@ This builtin command is used to print or erase functions. The default behavior of \c functions when called with no arguments, is to print the names and definitions of all defined functions. If any non-switch parameters are given, only the definition of the specified -functions are printed. +functions are printed. Automatically loaded functions can not be removed using functions -e. Either remove the definition file or change the diff --git a/doc_src/if.txt b/doc_src/if.txt index dbbd378f4..afad53843 100644 --- a/doc_src/if.txt +++ b/doc_src/if.txt @@ -8,7 +8,7 @@ if will execute the command CONDITION. If the condition's exit status is 0, the commands COMMANDS_TRUE will execute. If the exit status is not 0 and else is given, COMMANDS_FALSE will -be executed. +be executed. In order to use the exit status of multiple commands as the condition of an if block, use begin; ...; end and @@ -29,5 +29,5 @@ else end will print foo.txt exists if the file foo.txt -exists and is a regular file, otherwise it will print +exists and is a regular file, otherwise it will print foo.txt does not exist. diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in index fc8226f58..84dc0a034 100644 --- a/doc_src/index.hdr.in +++ b/doc_src/index.hdr.in @@ -59,7 +59,7 @@ Here is a list of some useful commands: - \c mv, move (rename) files - \c cp, copy files - \c open, open files with the default application associated with each filetype -- \c less, list the contents of files +- \c less, list the contents of files Commands and parameters are separated by the space character ( ). Every command ends with either a newline (i.e. by pressing @@ -147,7 +147,7 @@ these characters, so called escape sequences are provided. These are: Most program use three types of input/output (IO), each represented by a number called a file descriptor (FD). These are: -- Standard input, FD 0, for reading, defaults to reading from the keyboard. +- Standard input, FD 0, for reading, defaults to reading from the keyboard. - Standard output, FD 1, for writing, defaults to writing to the screen. - Standard error, FD 2, for writing errors and warnings, defaults to writing to the screen. @@ -160,13 +160,13 @@ default through a simple mechanism called a redirection. An example of a file redirection is echo hello \>output.txt, which directs the output of the echo command to the file error.txt. -- To redirect standard input, write \ -- To redirect standard output, write \>DESTINATION -- To redirect standard error, write ^DESTINATION +- To redirect standard input, write \ +- To redirect standard output, write \>DESTINATION +- To redirect standard error, write ^DESTINATION - To redirect standard output to a file which will be appended, write \>\>DESTINATION_FILE -- To redirect standard error to a file which will be appended, write ^^DESTINATION_FILE +- To redirect standard error to a file which will be appended, write ^^DESTINATION_FILE -DESTINATION can be one of the following: +DESTINATION can be one of the following: - A filename. The output will be written to the specified file. - An ampersand (\&) followed by the number of another file descriptor. The file descriptor will be a duplicate of the specified file descriptor. @@ -182,7 +182,7 @@ Any FD can be redirected in an arbitrary way by prefixing the redirection with the number of the FD. - To redirect input of FD number N, write N\ -- To redirect output of FD number N, write N\>DESTINATION +- To redirect output of FD number N, write N\>DESTINATION - To redirect output of FD number N to a file which will be appended, write N\>\>DESTINATION_FILE Example: echo Hello 2\>- and echo Hello ^- are @@ -230,7 +230,7 @@ Example: emacs \& -will start the emacs text editor in the background. +will start the emacs text editor in the background. \subsection syntax-job-control Job control @@ -323,10 +323,10 @@ function already be loaded, i.e. a circular dependency. \subsection syntax-conditional Conditional execution of code There are four fish builtins that let you execute commands only if a -specific criterion is met. These builtins are -if, -switch, -and and +specific criterion is met. These builtins are +if, +switch, +and and or. The \c switch command is used to execute one of possibly many blocks @@ -335,7 +335,7 @@ for switch for more information. The other conditionals use the exit status of a command to decide if a command or a block of commands -should be executed. See the documentation for +should be executed. See the documentation for if, and and or for more information. @@ -392,13 +392,13 @@ These are the general purpose tab completions that \c fish provides: of these completions are simple options like the \c -l option for \c ls, but some are more advanced. The latter include: -- The programs 'man' and 'whatis' show all installed +- The programs 'man' and 'whatis' show all installed manual pages as completions. -- The 'make' program uses all targets in the Makefile in +- The 'make' program uses all targets in the Makefile in the current directory as completions. - The 'mount' command uses all mount points specified in fstab as completions. -- The 'ssh' command uses all hosts that are stored -in the known_hosts file as completions. (see the ssh documentation for more information) +- The 'ssh' command uses all hosts that are stored +in the known_hosts file as completions. (see the ssh documentation for more information) - The 'su' command uses all users on the system as completions. - The \c apt-get, \c rpm and \c yum commands use all installed packages as completions. @@ -415,7 +415,7 @@ this can be specified as complete -c myprog -a 'start stop'. The argument to the \c -a switch is always a single string. At completion time, it will be tokenized on spaces and tabs, and variable expansion, command substitution and other forms of -parameter expansion will take place. +parameter expansion will take place. Fish has a special syntax to support specifying switches accepted by a command. The switches \c -s, \c -l and \c -o are used to specify a @@ -532,7 +532,7 @@ performing wildcard matching on files, inserting the value of environment variables into the parameter or even using the output of another command as a parameter list. -\subsection expand-wildcard Wildcards +\subsection expand-wildcard Wildcards If a star (*) or a question mark (?) is present in the parameter, \c fish attempts to match the given parameter to any files in such a @@ -609,7 +609,7 @@ href="#variables"> Environment variables section. Example: echo \$HOME prints the home directory of the current -user. +user. If you wish to combine environment variables with text, you can encase the variables within braces to embed a variable inside running @@ -687,9 +687,9 @@ performed: - If the string is the entire word \c self, the shells pid is the result - Otherwise, if the string is the id of a job, the result is the process group id of the job. -- Otherwise, if any child processes match the specified string, their -pids are the result of the expansion. -- Otherwise, if any processes owned by the user match the specified +- Otherwise, if any child processes match the specified string, their +pids are the result of the expansion. +- Otherwise, if any processes owned by the user match the specified string, their pids are the result of the expansion. This form of expansion is useful for commands like kill and fg, which @@ -739,7 +739,7 @@ expansion. To set a variable value, use the \c set command. -Example: +Example: To set the variable \c smurf_color to the value \c blue, use the command set smurf_color blue. @@ -869,7 +869,7 @@ echo $PATH[3] Note that array indices start at 1 in fish, not 0, as is more common in other languages. This is because many common Unix tools like seq -are more suited to such use. +are more suited to such use. If you do not use any brackets, all the elements of the array will be written as separate items. This means you can easily iterate over an @@ -921,13 +921,13 @@ certain environment variables. \c fish also sends additional information to the user through the values of certain environment variables. The user can not change the -values of most of these variables. +values of most of these variables. - \c _, which is the name of the currently running command. - \c argv, which is an array of arguments to the shell or function. \c argv is only defined when inside a function call, or if fish was invoked with a list of arguments, like 'fish myscript.fish foo bar'. This variable can be changed by the user. - \c history, which is an array containing the last commands that where entered. - \c HOME, which is the users home directory. This variable can only be changed by the root user. -- \c PWD, which is the current working directory. +- \c PWD, which is the current working directory. - \c status, which is the exit status of the last foreground job to exit. If the job was terminated through a signal, the exit status will be 128 plus the signal number. - \c USER, which is the username. This variable can only be changed by the root user. @@ -1024,7 +1024,7 @@ variables set the specified aspect of the locale information. LANG is a fallback value, it will be used if none of the LC_ variables are specified. -\section builtin-overview Builtins +\section builtin-overview Builtins Many other shells have a large library of builtin commands. Most of these commands are also available as standalone commands, but have @@ -1042,7 +1042,7 @@ switch of the command. The \c fish editor features copy and paste, a searchable history and many editor functions that can be bound to special keyboard -shortcuts. The most important keybinding is probably the tab key, which is bound to the complete function. +shortcuts. The most important keybinding is probably the tab key, which is bound to the complete function. Here are some of the commands available in the editor: - Tab completes the current token @@ -1060,12 +1060,12 @@ Here are some of the commands available in the editor: - Ctrl-l clear and repaint screen - Ctrl-w move previous word to the killring - Alt-d move next word to the killring -- Alt-w prints a short description of the command under the cursor -- Alt-l lists the contents of the current directory, unless the cursor is over a directory argument, in which case the contents of that directory will be listed +- Alt-w prints a short description of the command under the cursor +- Alt-l lists the contents of the current directory, unless the cursor is over a directory argument, in which case the contents of that directory will be listed - Alt-p adds the string '| less;' to the end of the job under the cursor. The result is that the output of the command will be paged. -You can change these key bindings using the -bind builtin command. +You can change these key bindings using the +bind builtin command. - \c backward-char, moves one character to the left @@ -1096,7 +1096,7 @@ If such a script produces output, the script needs to finish by calling 'commandline -f repaint' in order to tell fish that a repaint is in order. -\subsection killring Copy and paste (Kill Ring) +\subsection killring Copy and paste (Kill Ring) \c fish uses an Emacs style kill ring for copy and paste functionality. Use Ctrl-K to cut from the current cursor position to @@ -1107,7 +1107,7 @@ Meta-Y to rotate to the previous kill. If the environment variable DISPLAY is set, \c fish will try to connect to the X-windows server specified by this variable, and use -the clipboard on the X server for copying and pasting. +the clipboard on the X server for copying and pasting. \subsection history Searchable history @@ -1158,7 +1158,7 @@ graphical user interface from the terminal, and then be able to continue using the shell. In such cases, there are several ways in which the user can change fish's behavior. --# By ending a command with the \& (ampersand) symbol, the user tells \c fish to put the specified command into the background. A background process will be run simultaneous with \c fish. \c fish will retain control of the terminal, so the program will not be able to read from the keyboard. +-# By ending a command with the \& (ampersand) symbol, the user tells \c fish to put the specified command into the background. A background process will be run simultaneous with \c fish. \c fish will retain control of the terminal, so the program will not be able to read from the keyboard. -# By pressing ^Z, the user stops a currently running foreground program and returns control to \c fish. Some programs do not support this feature, or remap it to another key. Gnu emacs uses ^X z to stop running. -# By using the fg and bg builtin commands, the user can send any currently running job into the foreground or background. @@ -1247,7 +1247,7 @@ returning to the shell) when the \c fish_prompt function is called. Example:

-The default \c fish title is +The default \c fish title is 

@@ -1379,9 +1379,9 @@ href='fish-users@lists.sf.net'>fish-users@lists.sf.net.
 \subsection todo-features Missing features
 
 - Complete vi-mode key bindings
-- More completions (for example konsole, gnome-terminal, 
+- More completions (for example konsole, gnome-terminal,
 rlogin, rsync, arch, finger, bibtex, aspell, xpdf,
-compress, wine, dig, batch, 
+compress, wine, dig, batch,
 g++, javac, java, gcj, lpr, doxygen, whois)
 - Undo support
 - wait shellscript
@@ -1391,7 +1391,7 @@ g++, javac, java, gcj, lpr, doxygen, whois)
 
 \subsection todo-possible Possible features
 
-- mouse support like zsh has with http://stchaz.free.fr/mouse.zsh 
+- mouse support like zsh has with http://stchaz.free.fr/mouse.zsh
   installed would be awesome
 - suggest a completion on unique matches by writing it out in an understated color
 - Highlight beginning/end of block when moving over a block command
@@ -1408,7 +1408,7 @@ g++, javac, java, gcj, lpr, doxygen, whois)
 - History could reload itself when the file is updated. This would need to be done in a clever way to avoid chain reactions
 - The error function should probably be moved into it's own library, and be made mere general purpose.
 - The code validation functions should be moved from the parser to parse_util.
-- Try to remove more malloc calls to reduce memory usage. The time_t arrays used by the autoloader sound like a good candidate. 
+- Try to remove more malloc calls to reduce memory usage. The time_t arrays used by the autoloader sound like a good candidate.
 - The code validator should warn about unknown commands.
 - Auto-newlines
 - A fault injector could be written to increase robustness and testing of error recovery paths
@@ -1417,7 +1417,7 @@ g++, javac, java, gcj, lpr, doxygen, whois)
 - exec_subshell should be either merged with eval or moved to parser.c
 - Don't use expand_string to perform completions. wildcard_complete can be called directly, the brace expansion handling should be universal, and the process expansion can be moved to complete.c.
 - Make the history search support incremental searching
-- An automatic logout feature 
+- An automatic logout feature
 - Make tab completions completely silent by default, i.e. kill stderr when running completion commands. This needs to be overridalbe for debugging purposes.
 - Move history to an environment variable
 
@@ -1426,8 +1426,8 @@ g++, javac, java, gcj, lpr, doxygen, whois)
 - Suspending and then resuming pipelines containing a builtin or a shellscript function is broken. Ideally, the exec function in exec.c should be able to resume execution of a partially executed job.
 - delete-word is broken on the commandline 'sudo update-alternatives --config x-'
 - Sometimes autoheader needs to be run on a fresh tarball. Fix dates before creating tarballs.
-- The completion autoloader does not remember which completions where actually autoloaded, and may unload manually specified completions. 
-- There have been stray reports of issues with strange values of the PATH variable during startup. 
+- The completion autoloader does not remember which completions where actually autoloaded, and may unload manually specified completions.
+- There have been stray reports of issues with strange values of the PATH variable during startup.
 - bindings in config.fish are overwritten by default key bindings.
 - Adding 'bind -k ...' doesn't overwrite non-keybinding binds of the same sequence.
 - History file does not remove duplicates.
diff --git a/doc_src/license.hdr b/doc_src/license.hdr
index 5a5654c23..a05927b99 100644
--- a/doc_src/license.hdr
+++ b/doc_src/license.hdr
@@ -14,7 +14,7 @@ Version 2, June 1991
 

 
 
-Copyright (C) 1989, 1991 Free Software Foundation, Inc.  
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
 
 Everyone is permitted to copy and distribute verbatim copies
@@ -447,7 +447,7 @@ PERFORMANCE OF THIS SOFTWARE.
 
License for XSel

 
 The XSel command, written and copyrighted by Conrad Parker, is
-distributed together with \c fish. 
+distributed together with \c fish.
 
 
 It is Copyright (C) 2001 Conrad Parker 
@@ -802,7 +802,7 @@ of these things:
     that the user who changes the contents of definitions files in the
     Library will not necessarily be able to recompile the application
     to use the modified definitions.)
-	 
+
     
  • b) Use a suitable shared library mechanism for linking with the
     Library.  A suitable mechanism is one that (1) uses at run time a
     copy of the library already present on the user's computer system,
diff --git a/doc_src/math.txt b/doc_src/math.txt
index 0bef1437b..9455e0da0 100644
--- a/doc_src/math.txt
+++ b/doc_src/math.txt
@@ -9,7 +9,7 @@
 math is used to perform mathematical calculations. It is only a very
 thin wrapper for the bc program, that makes it possible to specify an
 expression from the command line without using non-standard extensions
-or a pipeline. Simply use a command like math 1+1. 
+or a pipeline. Simply use a command like math 1+1.
 
 For a description of the syntax supported by math, see the manual for
 the bc program. Keep in mind that parameter expansion takes place on
diff --git a/doc_src/mimedb.txt b/doc_src/mimedb.txt
index fbfcdf9ee..6a4e99446 100644
--- a/doc_src/mimedb.txt
+++ b/doc_src/mimedb.txt
@@ -5,7 +5,7 @@
 
 \subsection mimedb-description Description
 
-- \c FILES is a list of files to analyse 
+- \c FILES is a list of files to analyse
 - \c -t, \c --input-file-data the specified files type should be determined both by their filename and by their contents (Default)
 - \c -f, \c --input-filename the specified files type should be determined by their filename
 - \c -i, \c --input-mime the arguments are not files but mimetypes
diff --git a/doc_src/not.txt b/doc_src/not.txt
index 5adedc3a9..bb053da74 100644
--- a/doc_src/not.txt
+++ b/doc_src/not.txt
@@ -5,7 +5,7 @@
 
 \subsection not-description Description
 
-The \c not builtin is used to negate the exit status of another command. 
+The \c not builtin is used to negate the exit status of another command.
 
 \subsection not-example Example
 
diff --git a/doc_src/popd.txt b/doc_src/popd.txt
index 521059abb..b3c87584d 100644
--- a/doc_src/popd.txt
+++ b/doc_src/popd.txt
@@ -3,6 +3,6 @@
 \subsection popd-synopsis Synopsis
 popd
 
-\subsection popd-description Description 
-popd removes the top directory from the directory stack and 
+\subsection popd-description Description
+popd removes the top directory from the directory stack and
 cd's to the new top directory.
diff --git a/doc_src/prevd.txt b/doc_src/prevd.txt
index 57917f105..83d6b9093 100644
--- a/doc_src/prevd.txt
+++ b/doc_src/prevd.txt
@@ -3,7 +3,7 @@
 \subsection prevd-synopsis Synopsis
 prevd [-l | --list] [pos]
 
-\subsection prevd-description Description 
+\subsection prevd-description Description
 
 prevd moves backwards pos positions in the history
 of visited directories; if the beginning of the history has been hit,
diff --git a/doc_src/pushd.txt b/doc_src/pushd.txt
index 4a208791e..525690720 100644
--- a/doc_src/pushd.txt
+++ b/doc_src/pushd.txt
@@ -3,7 +3,7 @@
 \subsection pushd-synopsis Synopsis
 pushd [DIRECTORY]
 
-\subsection pushd-description Description 
+\subsection pushd-description Description
 The pushd function adds DIRECTORY to the top of the directory stack
 and makes it the current directory. Use popd to pop it off and and
 return to the original directory.
diff --git a/doc_src/random.txt b/doc_src/random.txt
index f6dd0928f..ad9b658a0 100644
--- a/doc_src/random.txt
+++ b/doc_src/random.txt
@@ -21,4 +21,4 @@ for i in (seq (random) -1 1)
 	echo $i
 	sleep
 end
-
    •  
+
    diff --git a/doc_src/read.txt b/doc_src/read.txt index 564b890a8..b85b5fd8f 100644 --- a/doc_src/read.txt +++ b/doc_src/read.txt @@ -6,12 +6,12 @@ \subsection read-description Description The read builtin causes fish to read one line from standard -input and store the result in one or more environment variables. +input and store the result in one or more environment variables. - -c CMD or --command=CMD specifies that the initial string in the interactive mode command buffer should be CMD. - -e or --export specifies that the variables will be exported to subshells. - -g or --global specifies that the variables will be made global. -- -m NAME or --mode-name=NAME specifies that the name NAME should be used to save/load the history file. If NAME is fish, the regular fish history will be available. +- -m NAME or --mode-name=NAME specifies that the name NAME should be used to save/load the history file. If NAME is fish, the regular fish history will be available. - -p PROMPT_CMD or --prompt=PROMPT_CMD specifies that the output of the shell command PROMPT_CMD should be used as the prompt for the interactive mode prompt. The default prompt command is set_color green; echo read; set_color normal; echo "> ". - -s or --shell Use syntax highlighting, tab completions and command termination suitable for entering shellscript code - -u or --unexport causes the specified environment not to be exported to child processes diff --git a/doc_src/return.txt b/doc_src/return.txt index e7883f37f..2cfd5ab62 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -3,7 +3,7 @@ \subsection return-synopsis Synopsis function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end -\subsection return-description Description +\subsection return-description Description The \c return builtin is used to halt a currently running function. It is usually added inside of a conditional block such as an set_color --bold white     will result in a white font color. Not all terminal emulators support all these features. This is not a -bug in set_color but a missing feature in the terminal emulator. +bug in set_color but a missing feature in the terminal emulator. set_color uses the terminfo database to look up how to change terminal colors on whatever terminal is in use. Some systems have old and diff --git a/doc_src/source.txt b/doc_src/source.txt index 05abc4fc1..9c6f11d3e 100644 --- a/doc_src/source.txt +++ b/doc_src/source.txt @@ -3,7 +3,7 @@ \subsection source-synopsis Synopsis . FILENAME [ARGUMENTS...] -\subsection source-description Description +\subsection source-description Description Evaluates the commands of the specified file in the current shell. This is different from starting a new process to perform the diff --git a/doc_src/ulimit.txt b/doc_src/ulimit.txt index ebed0f09b..6e21eba30 100644 --- a/doc_src/ulimit.txt +++ b/doc_src/ulimit.txt @@ -27,7 +27,7 @@ Note that not all these limits are available in all operating systems. The value of limit can be a number in the unit specified for the resource or one of the special values hard, soft, or unlimited, which stand for the current hard limit, the current soft limit, and no -limit, respectively. +limit, respectively. If limit is given, it is the new value of the specified resource. If no option is given, then -f is assumed. Values are in kilobytes, diff --git a/doc_src/vared.txt b/doc_src/vared.txt index bf383560e..9f1cef531 100644 --- a/doc_src/vared.txt +++ b/doc_src/vared.txt @@ -1,4 +1,4 @@ -\section vared vared - interactively edit the value of an environment variable +\section vared vared - interactively edit the value of an environment variable \subsection vared-synopsis Synopsis vared VARIABLE_NAME @@ -7,7 +7,7 @@ vared is used to interactively edit the value of an environment variable. Array variables as a whole can not be edited using vared, -but individual array elements can. +but individual array elements can. \subsection vared-example Example diff --git a/etc/config.fish.in b/etc/config.fish.in index 9ccf99b12..e32dc8bcc 100644 --- a/etc/config.fish.in +++ b/etc/config.fish.in @@ -39,7 +39,7 @@ if status --is-login end # -# There are variables that contain colons that are not arrays. This +# There are variables that contain colons that are not arrays. This # reverts them back to regular strings. # diff --git a/fish.spec.in b/fish.spec.in index a7403ffef..b16365597 100644 --- a/fish.spec.in +++ b/fish.spec.in @@ -11,7 +11,7 @@ URL: http://www.fishshell.org Source0: http://www.fishshell.org/files/%{version}/%{name}-%{version}.tar.bz2 BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) -BuildRequires: ncurses-devel gettext groff +BuildRequires: ncurses-devel gettext groff # Locate correct build time-dependencies for providing X headers @@ -50,10 +50,10 @@ BuildRequires: %{xinclude}/X11/Intrinsic.h, %{xinclude}/X11/Xatom.h %endif -%description +%description -fish is a shell geared towards interactive use. Its features are -focused on user friendliness and discoverability. The language syntax +fish is a shell geared towards interactive use. Its features are +focused on user friendliness and discoverability. The language syntax is simple but incompatible with other shell languages. @@ -75,7 +75,7 @@ make %{?_smp_mflags} %install rm -rf $RPM_BUILD_ROOT -make install DESTDIR="$RPM_BUILD_ROOT" +make install DESTDIR="$RPM_BUILD_ROOT" # Find translation files %find_lang %{name}.\* diff --git a/install-sh b/install-sh index e9de23842..594a4edbf 100755 --- a/install-sh +++ b/install-sh @@ -115,7 +115,7 @@ fi if [ x"$dir_arg" != x ]; then dst=$src src="" - + if [ -d $dst ]; then instcmd=: chmodcmd="" @@ -125,7 +125,7 @@ if [ x"$dir_arg" != x ]; then else # Waiting for this to be detected by the "$instcmd $src $dsttmp" command -# might cause directories to be created, which would be especially bad +# might cause directories to be created, which would be especially bad # if $src (and thus $dsttmp) contains '*'. if [ -f $src -o -d $src ] @@ -135,7 +135,7 @@ else echo "install: $src does not exist" exit 1 fi - + if [ x"$dst" = x ] then echo "install: no destination specified" @@ -163,7 +163,7 @@ dstdir=`echo $dst | sed -e 's,[^/]*$,,;s,/$,,;s,^$,.,'` # Skip lots of stat calls in the usual case. if [ ! -d "$dstdir" ]; then -defaultIFS=' +defaultIFS=' ' IFS="${IFS-${defaultIFS}}" @@ -202,17 +202,17 @@ else # If we're going to rename the final executable, determine the name now. - if [ x"$transformarg" = x ] + if [ x"$transformarg" = x ] then dstfile=`basename $dst` else - dstfile=`basename $dst $transformbasename | + dstfile=`basename $dst $transformbasename | sed $transformarg`$transformbasename fi # don't allow the sed command to completely eliminate the filename - if [ x"$dstfile" = x ] + if [ x"$dstfile" = x ] then dstfile=`basename $dst` else @@ -243,7 +243,7 @@ else # Now rename the file to the real destination. $doit $rmcmd -f $dstdir/$dstfile && - $doit $mvcmd $dsttmp $dstdir/$dstfile + $doit $mvcmd $dsttmp $dstdir/$dstfile fi && diff --git a/make_completions.py b/make_completions.py index 215999cd0..2a960ccb2 100755 --- a/make_completions.py +++ b/make_completions.py @@ -39,13 +39,13 @@ def print_completion( cmd, switch_arr, arg, desc ): if len(switch_arr)==0: return - + res = "complete -c %s" % (cmd) for sw in switch_arr: - + offset=1 switch_type = "o" - + if len(sw) == 2: switch_type = "s" @@ -98,7 +98,7 @@ for c in man: can_be_switch = True elif before_switch.find(c)<0: can_be_switch = False - + elif mode == MODE_SWITCH: if not switch_end.find(c)>=0: @@ -106,7 +106,7 @@ for c in man: else: if len(sw) > 1: sw_arr.append(sw) - + if switch_between_ignore.find(c) >= 0: mode=MODE_BETWEEN_IGNORE else: @@ -124,7 +124,7 @@ for c in man: elif not switch_between_continue.find(c) >= 0: mode = MODE_DESC desc = c - + elif mode == MODE_BETWEEN_IGNORE: if between_ignore.find(c)>=0: mode = MODE_BETWEEN @@ -139,20 +139,20 @@ for c in man: if c == '\n' and pc == '\n': stop=True - if stop: + if stop: mode=MODE_NONE - + print_completion( cmd, sw_arr, None, desc ) sw_arr = [] desc = '' - + else: desc += c else: print "Unknown mode", mode - + pc = c diff --git a/make_vcs_completions.fish b/make_vcs_completions.fish index 25c694147..b28e62cc2 100755 --- a/make_vcs_completions.fish +++ b/make_vcs_completions.fish @@ -21,7 +21,7 @@ end # # This function formats a list of completion information into a set of fish completions -# +# # The first argument is the condition string, which will be copied to # the resulting commandline verbatim # @@ -42,7 +42,7 @@ function complete_from_list set arg $exploded[3] set desc (cap (esc $exploded[4])) - set str + set str switch $short case '-?' @@ -65,7 +65,7 @@ function complete_from_list set str $str -x -a "'(__fish_complete_users)'" case '=FILENAME' '=FILE' ' ' - set str $str -r + set str $str -r case ' arg' set str $str -x @@ -89,7 +89,7 @@ function complete_from_list set str $str --description \'$desc\' end - echo complete -c $cmd $condition $str + echo complete -c $cmd $condition $str end @@ -101,7 +101,7 @@ function write_completions set -g cmd $argv[1]; or return 1 echo "Making completions for $cmd" >&2 - + echo ' # @@ -129,7 +129,7 @@ function write_completions switch $cmd case svn - function list_subcommand + function list_subcommand set cmd1 '\([^ ]*\)' set cmd2 '\([^,)]*\)' set cmdn '\(, \([^,)]*\)\|\)' @@ -155,7 +155,7 @@ function write_completions case cvs - function list_subcommand + function list_subcommand cmd --help-commands 2>| sed -n -e 's/^ *\([^ ][^ ]*\) .*$/\1/p' end @@ -167,7 +167,7 @@ function write_completions function list_subcommand_help #'s/^[ \t]*\(-.\)[ \t]\([^- \t][^ \t]*\)*[ \t]*\([^-].*\)$/\1\t\2\t\3/p' - cmd -H $argv 2>| sed -n -e 's/'$re'/\1\t\t\2\t\4/p' + cmd -H $argv 2>| sed -n -e 's/'$re'/\1\t\t\2\t\4/p' end echo ' @@ -181,12 +181,12 @@ function write_completions set cmd_str_internal (cmd --help-commands 2>| sed -n -e 's/^ *\([^ ][^ ]*\)[\t ]*\([^ ].*\)$/\1\t\2/p') for i in $cmd_str_internal set exploded (echo $i|tr \t \n) - set cmd_str $cmd_str "-a $exploded[1] --description '"(esc $exploded[2])"'" + set cmd_str $cmd_str "-a $exploded[1] --description '"(esc $exploded[2])"'" end case '*' - function list_subcommand + function list_subcommand cmd help | sed -n -e 's/^ *\([^ ][^ ]*\) .*$/\1/p' end @@ -203,7 +203,7 @@ function write_completions set cmd_str (cmd help | sed -n -e 's/^ *\([^ ][^ ]*\)[\t ]*\([^ ].*[^.]\)\(\|\\.\)$/-a \1 --description \'\2\'/p') end - + echo ' # # subcommands @@ -228,8 +228,8 @@ function write_completions end -set darcs_comp 'complete -c darcs -n "not __fish_use_subcommand" -a "(test -f _darcs/prefs/repos; and cat _darcs/prefs/repos)" --description "Darcs repo"' -set darcs_comp $darcs_comp 'complete -c darcs -a "test predist boringfile binariesfile" -n "contains setpref (commandline -poc)" --description "Set the specified option" -x' +set darcs_comp 'complete -c darcs -n "not __fish_use_subcommand" -a "(test -f _darcs/prefs/repos; and cat _darcs/prefs/repos)" --description "Darcs repo"' +set darcs_comp $darcs_comp 'complete -c darcs -a "test predist boringfile binariesfile" -n "contains setpref (commandline -poc)" --description "Set the specified option" -x' write_completions darcs $darcs_comp >share/completions/darcs.fish write_completions hg >share/completions/hg.fish diff --git a/po/en.po b/po/en.po index 33db3c275..8af215a52 100644 --- a/po/en.po +++ b/po/en.po @@ -562,7 +562,7 @@ msgid "%ls: Values cannot be specfied with erase\n" msgstr "%ls: Values cannot be specfied with erase\n" #: common.c:1756 -#, +#, msgid "This is a bug. " msgstr "This is a bug. " @@ -637,7 +637,7 @@ msgid "handler for generic event '%ls'" msgstr "handler for generic event “%ls”" #: event.c:264 -#, +#, msgid "Unknown event type" msgstr "Unknown event type" @@ -791,7 +791,7 @@ msgid "Could not set up output file descriptors for pager" msgstr "" #: fish_pager.c:1047 -#, +#, msgid "Could not set up input file descriptors for pager" msgstr "Could not set up input file descriptors for pager" @@ -817,7 +817,7 @@ msgid "Unspecified file descriptors" msgstr "Unspecified file descriptors" #: fish_pager.c:1359 -#, +#, msgid "Could not read completions" msgstr "Could not read completions" @@ -2609,7 +2609,7 @@ msgid "Specify a dir" msgstr "Specify a dir" #: share/completions/apt-src.fish:19 -#, +#, msgid "Omit debian version" msgstr "Omit debian version" diff --git a/seq.in b/seq.in index 47409484b..fed350923 100755 --- a/seq.in +++ b/seq.in @@ -1,5 +1,5 @@ #!/usr/bin/env fish -# +# # Fallback implementation of the seq command # # @configure_input@ @@ -45,4 +45,4 @@ for i in $from $step $to end end -echo "for( i=$from; i<=$to ; i+=$step ) i;" | bc +echo "for( i=$from; i<=$to ; i+=$step ) i;" | bc diff --git a/share/completions/adduser.fish b/share/completions/adduser.fish index da5b26900..0ce13ec80 100644 --- a/share/completions/adduser.fish +++ b/share/completions/adduser.fish @@ -13,7 +13,7 @@ complete -c adduser -l gecos --description 'Set the gecos field for the new entr complete -c adduser -l gid --description 'When creating a group, this option forces the new groupid to be the given number' -r complete -c adduser -l group --description 'When combined with --system, a group with the same name and ID as the system user is created' complete -c adduser -l help --description 'Display brief instructions' -complete -c adduser -l home --description 'Use specified directory as the user's home directory' -x -a '(__fish_complete_directories)' +complete -c adduser -l home --description 'Use specified directory as the user's home directory' -x -a '(__fish_complete_directories)' complete -c adduser -l shell --description 'Use shell as the user's login shell, rather than the default specified by the configuration file' -x -a '(cat /etc/shells)' complete -c adduser -l ingroup --description 'Add the new user to GROUP instead of a usergroup or the default group defined by USERS_GID in the configuration file' -x -a '(cat /etc/group|cut -d : -f 1)' complete -c adduser -l no-create-home --description 'Do not create the home directory, even if it doesn't exist' diff --git a/share/completions/arp.fish b/share/completions/arp.fish index 564d7a213..936438885 100644 --- a/share/completions/arp.fish +++ b/share/completions/arp.fish @@ -7,5 +7,5 @@ complete -x -c arp -s d -l delete -a "(__fish_print_hostnames)" --description "R complete -c arp -s D -l use-device --description "Use hardware address" complete -x -c arp -s i -l device -a "(__fish_print_interfaces)" --description "Select interface" complete -x -c arp -s s -l set --description "Manually create ARP address" -a "(__fish_print_hostnames)" -complete -f -c arp -s f -l file --description "Take addr from filename, default /etc/ethers" +complete -f -c arp -s f -l file --description "Take addr from filename, default /etc/ethers" diff --git a/share/completions/at.fish b/share/completions/at.fish index c23e83eea..59a35e059 100644 --- a/share/completions/at.fish +++ b/share/completions/at.fish @@ -2,7 +2,7 @@ complete -f -c at -s V --description "Display version and exit" complete -f -c at -s q --description "Use specified queue" complete -f -c at -s m --description "Send mail to user" -complete -c at -s f -x -a "(__fish_complete_suffix (commandline -ct) '' 'At job')" --description "Read job from file" +complete -c at -s f -x -a "(__fish_complete_suffix (commandline -ct) '' 'At job')" --description "Read job from file" complete -f -c at -s l --description "Alias for atq" complete -f -c at -s d --description "Alias for atrm" complete -f -c at -s v --description "Show the time" diff --git a/share/completions/bind.fish b/share/completions/bind.fish index a987d3c06..cf3ca5bf5 100644 --- a/share/completions/bind.fish +++ b/share/completions/bind.fish @@ -2,7 +2,7 @@ complete -c bind -s a -l all --description 'Show unavaliable key bindings/erase all bindings' complete -c bind -s e -l erase --description 'Erase mode' complete -c bind -s f -l function-names --description 'Print names of available functions' -complete -c bind -s h -l help --description "Display help and exit" +complete -c bind -s h -l help --description "Display help and exit" complete -c bind -s k -l key --description 'Specify key name, not sequence' complete -c bind -s K -l key-names --description 'Print names of available keys' diff --git a/share/completions/bunzip2.fish b/share/completions/bunzip2.fish index 9ce816da5..59204e74b 100644 --- a/share/completions/bunzip2.fish +++ b/share/completions/bunzip2.fish @@ -5,8 +5,8 @@ complete -c bunzip2 -x -a "( " complete -c bunzip2 -x -a "( - __fish_complete_suffix .bz - __fish_complete_suffix .bz2 + __fish_complete_suffix .bz + __fish_complete_suffix .bz2 ) " diff --git a/share/completions/bzcat.fish b/share/completions/bzcat.fish index 9e0c48084..e403ac9e9 100644 --- a/share/completions/bzcat.fish +++ b/share/completions/bzcat.fish @@ -5,8 +5,8 @@ complete -c bzcat -x -a "( " complete -c bzcat -x -a "( - __fish_complete_suffix .bz - __fish_complete_suffix .bz2 + __fish_complete_suffix .bz + __fish_complete_suffix .bz2 ) " diff --git a/share/completions/bzip2.fish b/share/completions/bzip2.fish index 2365de604..ad64c432e 100644 --- a/share/completions/bzip2.fish +++ b/share/completions/bzip2.fish @@ -6,8 +6,8 @@ complete -c bzip2 -s d -l decompress -x -a "( " complete -c bzip2 -s d -l decompress -x -a "( - __fish_complete_suffix .bz - __fish_complete_suffix .bz2 + __fish_complete_suffix .bz + __fish_complete_suffix .bz2 ) " diff --git a/share/completions/bzip2recover.fish b/share/completions/bzip2recover.fish index 756c3f99f..3f77afb71 100644 --- a/share/completions/bzip2recover.fish +++ b/share/completions/bzip2recover.fish @@ -5,7 +5,7 @@ complete -c bzip2recover -x -a "( " complete -c bzip2recover -x -a "( - __fish_complete_suffix .bz - __fish_complete_suffix .bz2 + __fish_complete_suffix .bz + __fish_complete_suffix .bz2 ) " diff --git a/share/completions/cdrecord.fish b/share/completions/cdrecord.fish index cb1481d5d..d38129ada 100644 --- a/share/completions/cdrecord.fish +++ b/share/completions/cdrecord.fish @@ -2,7 +2,7 @@ # Completions for Cdrecord # -complete -c cdrecord -o version --description "Display version and exit" +complete -c cdrecord -o version --description "Display version and exit" complete -c cdrecord -s v --description "Increment the level of general verbosity by one" complete -c cdrecord -s V --description "Increment the verbose level in respect of SCSI command transport by one" complete -c cdrecord -a "debug={1,2,3,4,5}" --description "Set the misc debug value to #" @@ -30,7 +30,7 @@ complete -c cdrecord -o waiti --description "Wait for input to become available complete -c cdrecord -o load --description "Load the media and exit" complete -c cdrecord -o lock --description "Load the media, lock the door and exit" complete -c cdrecord -o eject --description "Eject disk after doing the work" -complete -c cdrecord -a "speed={0,150,172,1385}" --description "Set the speed factor of the writing process to #" +complete -c cdrecord -a "speed={0,150,172,1385}" --description "Set the speed factor of the writing process to #" complete -c cdrecord -a "blank={help,all,fast,track,unreserve,trtail,unclose,session}" --description "Blank a CD-RW and exit or blank a CD-RW before writing" complete -c cdrecord -o format --description "Format a CD-RW/DVD-RW/DVD+RW disc" complete -c cdrecord -a "fs=" --description "Set the FIFO (ring buffer) size to #" diff --git a/share/completions/configure.fish b/share/completions/configure.fish index 699c28c00..8834842be 100644 --- a/share/completions/configure.fish +++ b/share/completions/configure.fish @@ -9,6 +9,6 @@ complete -c configure -l prefix --description "Architecture-independent install complete -c configure -l exec-prefix --description "Architecture-dependent install directory" -a "__fish_complete_directories (commandline -ct)" -x complete -c configure -l build --description "Configure for building on BUILD" -x complete -c configure -l host --description "Cross-compile to build programs to run on HOST" -x -complete -c configure -l target --description "Configure for building compilers for TARGET" -x +complete -c configure -l target --description "Configure for building compilers for TARGET" -x complete -c configure -u diff --git a/share/completions/df.fish b/share/completions/df.fish index 22ec46521..6f3c98dd7 100644 --- a/share/completions/df.fish +++ b/share/completions/df.fish @@ -6,7 +6,7 @@ # Test if we are using GNU sed # -set -l is_gnu +set -l is_gnu df --version >/dev/null ^/dev/null; and set is_gnu --is-gnu __fish_gnu_complete -c df -s h -l human-readable --description "Human readable sizes" $is_gnu diff --git a/share/completions/find.fish b/share/completions/find.fish index 473109d87..eba8392b3 100644 --- a/share/completions/find.fish +++ b/share/completions/find.fish @@ -9,7 +9,7 @@ complete -c find -s L -o follow --description "Follow symlinks" complete -c find -s H --description "Do not follow symbolic links, except while processing the command line arguments" -# General options +# General options complete -c find -o daystart --description "Measure from the beginning of today rather than from 24 hours ago" complete -c find -s d -o depth --description "Process subdirectories before the directory itself" @@ -36,8 +36,8 @@ complete -c find -o cmin --description "File status last changed specified numbe complete -c find -o cnewer --description "File status last changed more recently than file was modified" -r complete -c find -o ctime --description "File status last changed specified number of days ago" -r -complete -c find -o empty --description "File is empty and is either a regular file or a directory" -complete -c find -o false --description "Always false" +complete -c find -o empty --description "File is empty and is either a regular file or a directory" +complete -c find -o false --description "Always false" complete -c find -o fstype --description "File is on filesystem of specified type" -a "(__fish_print_filesystems)" -r complete -c find -o gid --description "Numeric group id of file" -r complete -c find -o group --description "Group name of file" -a "(__fish_complete_groups)" @@ -99,7 +99,7 @@ complete -c find -o prune --description "Do not recurse unless -depth is specifi complete -c find -o quit --description "Exit at once" complete -c find -o ls --description "List file in ls -dils format" -r -# Grouping +# Grouping complete -c find -o not --description "Negate result of action" complete -c find -o and -s a --description "Result is only true if both previous and next action are true" diff --git a/share/completions/flac.fish b/share/completions/flac.fish index 343ae8092..40cd2a471 100644 --- a/share/completions/flac.fish +++ b/share/completions/flac.fish @@ -74,7 +74,7 @@ complete -c flac -l no-replay-gain -d "Don't calculate ReplayGain & store in Vor complete -c flac -l no-residual-gnuplot -d "Don't generate gnuplot files of residual distribution" complete -c flac -l no-residual-text -d "Don't include residual signal in text output" complete -c flac -l no-sector-align -d "Don't align multiple files on sector boundaries" -complete -c flac -l no-seektable +complete -c flac -l no-seektable complete -c flac -l no-silent -d "Write runtime encode/decode statistics" complete -c flac -l no-force -d "Don't force overwriting of output files" complete -c flac -l no-verify -d "Don't verify a correct encoding" diff --git a/share/completions/git.fish b/share/completions/git.fish index 6bc288c99..46a75188c 100644 --- a/share/completions/git.fish +++ b/share/completions/git.fish @@ -117,7 +117,7 @@ complete -f -c git -n '__fish_git_using_command branch' -s M -d 'Force renaming complete -f -c git -n '__fish_git_using_command branch' -s a -d 'Lists both local and remote branches' ### cherry-pick -complete -f -c git -n '__fish_git_needs_command' -a cherry-pick -d 'Apply the change introduced by an existing commit' +complete -f -c git -n '__fish_git_needs_command' -a cherry-pick -d 'Apply the change introduced by an existing commit' complete -f -c git -n '__fish_git_using_command cherry-pick' -a '(__fish_git_branches)' -d 'Branch' # TODO options diff --git a/share/completions/gpg.fish b/share/completions/gpg.fish index ce43266ce..f4d937ac7 100644 --- a/share/completions/gpg.fish +++ b/share/completions/gpg.fish @@ -1,5 +1,5 @@ # -# Completions for the gpg command. +# Completions for the gpg command. # # This program accepts an rather large number of switches. It allows # you to do things like changing what file descriptor errors should be @@ -22,7 +22,7 @@ function __fish_complete_gpg_user_id -d "Complete using gpg user ids" # gpg doesn't seem to like it when you use the whole key name as a # completion, so we skip the part and use it a s a - # description. + # description. gpg --list-keys --with-colon|cut -d : -f 10|sed -ne 's/\(.*\) <\(.*\)>/\1'\t'\2/p' end @@ -49,7 +49,7 @@ complete -c gpg -s s -l sign --description "Make a signature" complete -c gpg -l clearsign --description "Make a clear text signature" complete -c gpg -s b -l detach-sign --description "Make a detached signature" complete -c gpg -s e -l encrypt --description "Encrypt data" -complete -c gpg -s c -l symmetric --description "Encrypt with a symmetric cipher using a passphrase" +complete -c gpg -s c -l symmetric --description "Encrypt with a symmetric cipher using a passphrase" complete -c gpg -l store --description "Store only (make a simple RFC1991 packet)" complete -c gpg -l decrypt --description "Decrypt specified file or stdin" complete -c gpg -l verify --description "Assume specified file or stdin is sigfile and verify it" @@ -76,7 +76,7 @@ complete -c gpg -l delete-key -xa "(__fish_complete_gpg_user_id)" --description complete -c gpg -l delete-secret-key -xa "(__fish_complete_gpg_user_id)" --description "Remove key from the secret and public keyring" complete -c gpg -l delete-secret-and-public-key -xa "(__fish_complete_gpg_user_id)" --description "Same as --delete-key, but if a secret key exists, it will be removed first" -complete -c gpg -l gen-revoke -xa "(__fish_complete_gpg_user_id)" --description "Generate a revocation certificate for the complete key" +complete -c gpg -l gen-revoke -xa "(__fish_complete_gpg_user_id)" --description "Generate a revocation certificate for the complete key" complete -c gpg -l desig-revoke -xa "(__fish_complete_gpg_user_id)" --description "Generate a designated revocation certificate for a key" complete -c gpg -l export -xa "(__fish_append , (__fish_complete_gpg_user_id))" --description 'Export all or the given keys from all keyrings' @@ -91,7 +91,7 @@ complete -c gpg -l recv-keys -xa "(__fish_complete_gpg_key_id)" --description "I complete -c gpg -l refresh-keys -xa "(__fish_complete_gpg_key_id)" --description "Request updates from a keyserver for keys that already exist on the local keyring" complete -c gpg -l search-keys -xa "(__fish_append , (__fish_complete_gpg_user_id) )" --description "Search the keyserver for the given names" complete -c gpg -l update-trustdb --description "Do trust database maintenance" -complete -c gpg -l check-trustdb --description "Do trust database maintenance without user interaction" +complete -c gpg -l check-trustdb --description "Do trust database maintenance without user interaction" complete -c gpg -l export-ownertrust --description "Send the ownertrust values to stdout" complete -c gpg -l import-ownertrust --description "Update the trustdb with the ownertrust values stored in specified files or stdin" @@ -137,7 +137,7 @@ complete -c gpg -l bzip2-decompress-lowmem --description "Use a different decomp complete -c gpg -s t -l textmode --description "Treat input files as text and store them in the OpenPGP canonical text form with standard 'CRLF' line endings" complete -c gpg -l no-textmode --description "Don't treat input files as text and store them in the OpenPGP canonical text form with standard 'CRLF' line endings" -complete -c gpg -s n -l dry-run --description "Don't make any changes (this is not completely implemented)" +complete -c gpg -s n -l dry-run --description "Don't make any changes (this is not completely implemented)" complete -c gpg -s i -l interactive --description "Prompt before overwrite" @@ -210,7 +210,7 @@ complete -c gpg -l sig-keyserver-url -x --description "Use specified URL as a pr complete -c gpg -l set-filename -x --description "Use specified string as the filename which is stored inside messages" complete -c gpg -l for-your-eyes-only --description "Set the 'for your eyes only' flag in the message" -complete -c gpg -l no-for-your-eyes-only --description "Clear the 'for your eyes only' flag in the message" +complete -c gpg -l no-for-your-eyes-only --description "Clear the 'for your eyes only' flag in the message" complete -c gpg -l use-embedded-filename --description "Create file with name as given in data" complete -c gpg -l no-use-embedded-filename --description "Don't create file with name as given in data" diff --git a/share/completions/gprof.fish b/share/completions/gprof.fish index cbccb6280..91ea9ce0a 100644 --- a/share/completions/gprof.fish +++ b/share/completions/gprof.fish @@ -19,7 +19,7 @@ complete -c gprof -s x -l all-lines --description "Annotate every line" complete -xc gprof -l demangle --description "Set demangling style" complete -c gprof -l no-demangle --description "Turn of demangling" complete -xc gprof -s a -l no-static --description "Supress static functions" -complete -xc gprof -s c -l static-call-graph +complete -xc gprof -s c -l static-call-graph complete -xc gprof -s D -l ignore-non-functions --description "Ignore symbols not known to be functions" complete -xc gprof -s k -r --description "Delete arcs from callgraph" complete -xc gprof -s l -l line --description "Line by line profiling" diff --git a/share/completions/gzip.fish b/share/completions/gzip.fish index 10c5b8ab3..507eb71d9 100644 --- a/share/completions/gzip.fish +++ b/share/completions/gzip.fish @@ -1,7 +1,7 @@ complete -c gzip -s c -l stdout --description "Compress to stdout" complete -c gzip -s d -l decompress -x -a " ( - __fish_complete_suffix .gz + __fish_complete_suffix .gz __fish_complete_suffix .tgz ) " diff --git a/share/completions/kill.fish b/share/completions/kill.fish index c85d983c0..724effa6d 100644 --- a/share/completions/kill.fish +++ b/share/completions/kill.fish @@ -4,7 +4,7 @@ set -l signals if kill -L ^/dev/null >/dev/null - # Debian and some related systems use 'kill -L' to write out a numbered list + # Debian and some related systems use 'kill -L' to write out a numbered list # of signals. Use this to complete on both number _and_ on signal name. complete -c kill -s L --description "List codes and names of available signals" @@ -12,7 +12,7 @@ if kill -L ^/dev/null >/dev/null set signals (kill -L | sed -e 's/\([0-9][0-9]*\) *\([A-Z,0-9][A-Z,0-9]*\)/\1 \2\n/g;s/ +/ /g' | sed -e 's/^ //' | sgrep -E '^[^ ]+') else - + # Posix systems print out the name of a signal using 'kill -l # SIGNUM', so we use this instead. @@ -30,7 +30,7 @@ for i in $signals complete -c kill -o $number -d $name complete -c kill -o $name -d $name complete -c kill -o s -x -a \"$number\tSend\ $name\ signal\" - complete -c kill -o s -x -a \"$name\tSend\ $name\ signal\" + complete -c kill -o s -x -a \"$name\tSend\ $name\ signal\" end diff --git a/share/completions/make.fish b/share/completions/make.fish index 0c89d52a2..05845e10d 100644 --- a/share/completions/make.fish +++ b/share/completions/make.fish @@ -5,7 +5,7 @@ # filename completion. Unfortunatly, this turns out to be a bit # complicated to do. -set -l is_assignment "commandline -ct|sgrep '..*='" +set -l is_assignment "commandline -ct|sgrep '..*='" set -l complete_file_assignment '(commandline -ct)(complete --do-complete=this_command_does_not_exist\ (commandline -ct|sed -e \'s/.*=//\'))' complete -c make --condition $is_assignment -a $complete_file_assignment diff --git a/share/completions/modprobe.fish b/share/completions/modprobe.fish index e6625ab32..f36af1c69 100644 --- a/share/completions/modprobe.fish +++ b/share/completions/modprobe.fish @@ -15,7 +15,7 @@ complete -c modprobe -s V -l version --description "Display version and exit" complete -c modprobe -s f -l force --description "Ignore all version information" complete -c modprobe -l force-vermagic --description "Ignore version magic information" complete -c modprobe -l force-modversion --description "Ignore module interface version" -complete -c modprobe -s l -l list --description "List all modules matching the given wildcard" +complete -c modprobe -s l -l list --description "List all modules matching the given wildcard" complete -c modprobe -s a -l all --description "Insert modules matching the given wildcard" complete -c modprobe -s t -l type --description "Restrict wildcards to specified directory" complete -c modprobe -s s -l syslog --description "Send error messages through syslog" diff --git a/share/completions/mplayer.fish b/share/completions/mplayer.fish index ff894bed1..62eaee204 100644 --- a/share/completions/mplayer.fish +++ b/share/completions/mplayer.fish @@ -7,19 +7,19 @@ # set mplayer_lang " - de\tGerman - dk\tDanish - en\tEnglish + de\tGerman + dk\tDanish + en\tEnglish es\tSpanish - fi\tFinnish - fr\tFrench + fi\tFinnish + fr\tFrench gr\tGreek hu\tHungarian it\tItalian - jp\tJapanese - no\tNorwegian - hu\tHungarian - pl\tPolish + jp\tJapanese + no\tNorwegian + hu\tHungarian + pl\tPolish pt\tPortugese se\Swedish " diff --git a/share/completions/pacman.fish b/share/completions/pacman.fish index 89912468a..54662f69f 100644 --- a/share/completions/pacman.fish +++ b/share/completions/pacman.fish @@ -32,9 +32,9 @@ complete -c pacman -n '__fish_contains_opt -s Q' -s l -d 'List all files owned b complete -c pacman -n '__fish_contains_opt -s Q' -s p -d 'Apply the query to a package file and not to an installed package' # Remove options -complete -c pacman -n '__fish_contains_opt -s R' -s c -d 'Remove also the packages that depends on the target packages' -complete -c pacman -n '__fish_contains_opt -s R' -s k -d 'Remove the database entries only' -complete -c pacman -n '__fish_contains_opt -s R' -s n -d 'Ignore file backup designations' +complete -c pacman -n '__fish_contains_opt -s R' -s c -d 'Remove also the packages that depends on the target packages' +complete -c pacman -n '__fish_contains_opt -s R' -s k -d 'Remove the database entries only' +complete -c pacman -n '__fish_contains_opt -s R' -s n -d 'Ignore file backup designations' complete -c pacman -n '__fish_contains_opt -s R' -s s -d 'Remove also the dependencies of the target packages' # Sync options @@ -54,6 +54,6 @@ complete -c pacman -n '__fish_contains_opt -s S' -l noprogressbar -d 'Do not sho # Complete with local packages complete -c pacman -n '__fish_contains_opt -s A -s F -s U' -a '(__fish_complete_suffix pkg.tar.gz)' -d 'Local package' # Complete with installed packages -complete -c pacman -n '__fish_contains_opt -s Q -s R' -a '(pacman -Q | cut --delim " " --fields 1)' -d 'Installed package' +complete -c pacman -n '__fish_contains_opt -s Q -s R' -a '(pacman -Q | cut --delim " " --fields 1)' -d 'Installed package' # Complete with packages in the repos complete -c pacman -n '__fish_contains_opt -s S' -a '(pacman -Sl | cut --delim " " --fields 2 | sort)' -d 'Repo package' diff --git a/share/completions/ping.fish b/share/completions/ping.fish index 37ef21acb..1ddebc048 100644 --- a/share/completions/ping.fish +++ b/share/completions/ping.fish @@ -13,7 +13,7 @@ complete -c ping -s l --description "Send the specified number of packets withou complete -c ping -s L --description "Suppress loopback of multicast packets" complete -c ping -s n --description "Numeric output only" complete -c ping -s p --description "Pad packet with empty bytes" -x -complete -c ping -s Q --description "Set Quality of Service -related bits in ICMP datagrams" -x +complete -c ping -s Q --description "Set Quality of Service -related bits in ICMP datagrams" -x complete -c ping -s q --description "Quiet mode" complete -c ping -s R --description "Record route" complete -c ping -s r --description "Bypass the normal routing tables and send directly to a host on an attached interface" diff --git a/share/completions/quilt.fish b/share/completions/quilt.fish index acfc5d784..6bf353cca 100644 --- a/share/completions/quilt.fish +++ b/share/completions/quilt.fish @@ -16,7 +16,7 @@ complete -c quilt -a fork -r --no-file -d " Fork the topmost patch" complete -c quilt -a graph -r --no-file -d "Generate a dot(1) directed graph showing the dependencies between applied patches" complete -c quilt -a grep -r --no-file -d "Grep through the source files, recursively, skipping patches and quilt meta-information" complete -c quilt -a header -r --no-file -d " Print or change the header of the topmost or specified patch" -complete -c quilt -a import -r -d "Import external patches" +complete -c quilt -a import -r -d "Import external patches" complete -c quilt -a mail -r -d "Create mail messages from all patches in the series file, and either store or send them" complete -c quilt -a new -r -d "Create a new patch with the specified file name, and insert it after the topmost patch" complete -c quilt -a next -r -d "Print the name of the next patch after the specified or topmost patch in the series file" diff --git a/share/completions/scons.fish b/share/completions/scons.fish index 5cba11560..5648d3c54 100644 --- a/share/completions/scons.fish +++ b/share/completions/scons.fish @@ -12,8 +12,8 @@ complete -c scons -l cache-force -l cache-populate --description 'When using Cac complete -c scons -l cache-show --description 'When using CacheDir() and retrieving a derived file from the cache, show the command that would have been executed to build the file, instead of the usual report, "Retrieved file from cache' complete -c scons -l config --description 'This specifies how the Configure call should use or generate the results of configuration tests' -a ' - auto\t"Use normal dependency mechanism" - force\t"Rerun all tests" + auto\t"Use normal dependency mechanism" + force\t"Rerun all tests" cache\t"Take all results from cache"' -x complete -c scons -s C --description 'Directory, --directory=directory Change to the specified directory before searching for the SCon struct, Sconstruct, or sconstruct file, or doing anything else' diff --git a/share/completions/sed.fish b/share/completions/sed.fish index 715d4dee8..dd953ac43 100644 --- a/share/completions/sed.fish +++ b/share/completions/sed.fish @@ -4,12 +4,12 @@ # Test if we are using GNU sed -set -l is_gnu +set -l is_gnu sed --version >/dev/null ^/dev/null; and set is_gnu --is-gnu # Shared ls switches -__fish_gnu_complete -c sed -s n -l quiet --description "Silent mode" $is_gnu +__fish_gnu_complete -c sed -s n -l quiet --description "Silent mode" $is_gnu __fish_gnu_complete -c sed -s e -l expression -x --description "Evaluate expression" $is_gnu __fish_gnu_complete -c sed -s f -l file -r --description "Evalute file" $is_gnu __fish_gnu_complete -c sed -s i -l in-place --description "Edit files in place" $is_gnu diff --git a/share/completions/set.fish b/share/completions/set.fish index 4ff267162..86647e969 100644 --- a/share/completions/set.fish +++ b/share/completions/set.fish @@ -22,11 +22,11 @@ function __fish_set_is_color -d 'Test if We are specifying a color value for the return 0 case '-*' - + case '*' return 1 end - end + end return 1 end @@ -40,11 +40,11 @@ function __fish_set_is_locale -d 'Test if We are specifying a locale value for t return 0 case '-*' - + case '*' return 1 end - end + end return 1 end diff --git a/share/completions/status.fish b/share/completions/status.fish index cb4040321..dc98703af 100644 --- a/share/completions/status.fish +++ b/share/completions/status.fish @@ -7,5 +7,5 @@ complete -c status -l is-login --description "Test if this is a login shell" complete -c status -l is-full-job-control --description "Test if all new jobs are put under job control" complete -c status -l is-interactive-job-control --description "Test if only interactive new jobs are put under job control" complete -c status -l is-no-job-control --description "Test if new jobs are never put under job control" -complete -c status -s j -l job-control -xa "full interactive none" --description "Set which jobs are out under job control" +complete -c status -s j -l job-control -xa "full interactive none" --description "Set which jobs are out under job control" complete -c status -s t -l print-stack-trace --description "Print a list of all function calls leading up to running the current command" diff --git a/share/completions/su.fish b/share/completions/su.fish index c75a617e0..990a0ae50 100644 --- a/share/completions/su.fish +++ b/share/completions/su.fish @@ -2,7 +2,7 @@ complete -x -c su -a "(__fish_complete_users)" complete -c su -s l -l login --description "Make login shell" -complete -r -c su -s c -l command --description "Pass command to shell" -xa "(__fish_complete_command)" +complete -r -c su -s c -l command --description "Pass command to shell" -xa "(__fish_complete_command)" complete -c su -s f -l fast --description "Pass -f to the shell" complete -c su -s m -l preserve_environment --description "Preserve environment" complete -c su -s p --description "Preserve environment" diff --git a/share/completions/unrar.fish b/share/completions/unrar.fish index c457936b8..a6e0a9ba9 100644 --- a/share/completions/unrar.fish +++ b/share/completions/unrar.fish @@ -3,9 +3,9 @@ complete -c unrar -a "(__fish_complete_unrar)" complete -x -c unrar -n '__fish_use_subcommand' -a e --description "Extract files to current directory" -complete -x -c unrar -n '__fish_use_subcommand' -a l --description "List archive" -complete -x -c unrar -n '__fish_use_subcommand' -a lt --description "List archive (technical)" -complete -x -c unrar -n '__fish_use_subcommand' -a lb --description "List archive (bare)" +complete -x -c unrar -n '__fish_use_subcommand' -a l --description "List archive" +complete -x -c unrar -n '__fish_use_subcommand' -a lt --description "List archive (technical)" +complete -x -c unrar -n '__fish_use_subcommand' -a lb --description "List archive (bare)" complete -x -c unrar -n '__fish_use_subcommand' -a p --description "Print file to stdout" complete -x -c unrar -n '__fish_use_subcommand' -a t --description "Test archive files" complete -x -c unrar -n '__fish_use_subcommand' -a v --description "Verbosely list archive" diff --git a/share/completions/xargs.fish b/share/completions/xargs.fish index 9858ed550..13948b529 100644 --- a/share/completions/xargs.fish +++ b/share/completions/xargs.fish @@ -6,15 +6,15 @@ complete -c xargs -s 0 -l null --description "Input filenames are terminated by complete -c xargs -s e -l eof --description "Set the end of file string to eof-str" complete -c xargs -s E -r -f --description "Set the end of file string to eof-str" complete -c xargs -l help --description "Display help and exit" -complete -c xargs -s i -l replace --description "Replace replace-str in the initial arguments with names from standard input" +complete -c xargs -s i -l replace --description "Replace replace-str in the initial arguments with names from standard input" complete -c xargs -s I -r -f --description "Replace replace-str in the initial arguments with names from standard input" complete -c xargs -s l -l max-lines --description "Use at most max-lines nonblank input lines per command line" complete -c xargs -s L -r -f --description "Use at most max-lines nonblank input lines per command line" complete -c xargs -s n -l max-args -r -f --description "Use at most max-args arguments per command line" complete -c xargs -s p -l interactive --description "Prompt the user about whether to run each command line and read a line from the terminal" -complete -c xargs -s r -l no-run-if-empty --description "If the standard input does not contain any nonblanks, do not run the command" +complete -c xargs -s r -l no-run-if-empty --description "If the standard input does not contain any nonblanks, do not run the command" complete -c xargs -s s -l max-chars -r -f --description "Use at most max-chars characters per command line" complete -c xargs -s t -l verbose --description "Print the command line on the standard error output before executing it" complete -c xargs -l version --description "Display version and exit" complete -c xargs -s x -l exit --description "Exit if the size is exceeded" -complete -c xargs -s P -l max-procs -r -f --description "Run up to max-procs processes at a time" +complete -c xargs -s P -l max-procs -r -f --description "Run up to max-procs processes at a time" diff --git a/share/completions/xprop.fish b/share/completions/xprop.fish index 612f42eaf..da56ea609 100644 --- a/share/completions/xprop.fish +++ b/share/completions/xprop.fish @@ -9,7 +9,7 @@ complete -c xprop -o display --description "Specify X server" complete -c xprop -o len -x --description "Maximum display length" complete -c xprop -o notype --description "Do not show property type" complete -c xprop -o fs -r --description "Set format file" -complete -c xprop -o frame --description "Select a window by clicking on its frame" +complete -c xprop -o frame --description "Select a window by clicking on its frame" complete -c xprop -o remove --description "Remove property" -x -a " ( xprop -root -notype|cut -d ' ' -f 1|cut -d \t -f 1 diff --git a/share/completions/yum.fish b/share/completions/yum.fish index 78dcb5874..e5a9d20bb 100644 --- a/share/completions/yum.fish +++ b/share/completions/yum.fish @@ -7,7 +7,7 @@ # Test if completing using package names is appropriate function __fish_yum_package_ok for i in (commandline -poc) - if contains $i update upgrade remove erase + if contains $i update upgrade remove erase return 0 end end @@ -27,21 +27,21 @@ complete -c yum -n '__fish_use_subcommand' -xa generate-rss --description "Gener complete -c yum -n '__fish_yum_package_ok' -a "(__fish_print_packages)" -complete -c yum -s h -l help --description "Display help and exit" -complete -c yum -s y --description "Assume yes to all questions" -complete -c yum -s c --description "Configuration file" -r -complete -c yum -s d --description "Set debug level" -x -complete -c yum -s e --description "Set error level" -x -complete -c yum -s t -l tolerant --description "Be tolerant of errors in commandline" +complete -c yum -s h -l help --description "Display help and exit" +complete -c yum -s y --description "Assume yes to all questions" +complete -c yum -s c --description "Configuration file" -r +complete -c yum -s d --description "Set debug level" -x +complete -c yum -s e --description "Set error level" -x +complete -c yum -s t -l tolerant --description "Be tolerant of errors in commandline" complete -c yum -s R --description "Set maximum delay between commands" -x -complete -c yum -s c --description "Run commands from cache" -complete -c yum -l version --description "Display version and exit" -complete -c yum -l installroot --description "Specify installroot" -r -complete -c yum -l enablerepo --description "Enable repository" -r +complete -c yum -s c --description "Run commands from cache" +complete -c yum -l version --description "Display version and exit" +complete -c yum -l installroot --description "Specify installroot" -r +complete -c yum -l enablerepo --description "Enable repository" -r complete -c yum -l disablerepo --description "Disable repository" -r -complete -c yum -l obsoletes --description "Enables obsolets processing logic" -complete -c yum -l rss-filename --description "Output rss-data to file" -r -complete -c yum -l exclude --description "Exclude specified package from updates" -a "(__fish_print_packages)" +complete -c yum -l obsoletes --description "Enables obsolets processing logic" +complete -c yum -l rss-filename --description "Output rss-data to file" -r +complete -c yum -l exclude --description "Exclude specified package from updates" -a "(__fish_print_packages)" complete -c yum -n 'contains list (commandline -poc)' -a all --description 'List all packages' complete -c yum -n 'contains list (commandline -poc)' -a available --description 'List packages available for installation' diff --git a/share/config.fish.in b/share/config.fish.in index 085d8a85e..dc1c0f074 100644 --- a/share/config.fish.in +++ b/share/config.fish.in @@ -34,20 +34,20 @@ end # Set up function and completion paths. Make sure that the fish # default functions/completions are included in the respective path. -if not set -q fish_function_path - set -U fish_function_path $configdir/fish/functions @sysconfdir@/fish/functions @datadir@/fish/functions +if not set -q fish_function_path + set -U fish_function_path $configdir/fish/functions @sysconfdir@/fish/functions @datadir@/fish/functions end -if not contains @datadir@/fish/functions $fish_function_path - set fish_function_path[-1] @datadir@/fish/functions +if not contains @datadir@/fish/functions $fish_function_path + set fish_function_path[-1] @datadir@/fish/functions end -if not set -q fish_complete_path - set -U fish_complete_path $configdir/fish/completions @sysconfdir@/fish/completions @datadir@/fish/completions +if not set -q fish_complete_path + set -U fish_complete_path $configdir/fish/completions @sysconfdir@/fish/completions @datadir@/fish/completions end -if not contains @datadir@/fish/completions $fish_complete_path - set fish_complete_path[-1] @datadir@/fish/completions +if not contains @datadir@/fish/completions $fish_complete_path + set fish_complete_path[-1] @datadir@/fish/completions end set __fish_help_dir @docdir@ @@ -62,9 +62,9 @@ set __fish_help_dir @docdir@ if test -d /usr/xpg4/bin if not contains /usr/xpg4/bin $PATH - set PATH /usr/xpg4/bin $PATH + set PATH /usr/xpg4/bin $PATH end -end +end # # Add a few common directories to path, if they exists. Note that pure diff --git a/share/functions/__fish_append.fish b/share/functions/__fish_append.fish index 41b92d439..43caa26c0 100644 --- a/share/functions/__fish_append.fish +++ b/share/functions/__fish_append.fish @@ -1,7 +1,7 @@ function __fish_append -d "Internal completion function for appending string to the commandline" --argument separator set -e argv[1] set str (commandline -tc| sed -ne "s/\(.*$separator\)[^$separator]*/\1/p"|sed -e "s/--.*=//") - printf "%s\n" "$str"$argv "$str"(printf "%s\n" $argv|sed -e "s/\(\t\|\$\)/,\1/") + printf "%s\n" "$str"$argv "$str"(printf "%s\n" $argv|sed -e "s/\(\t\|\$\)/,\1/") end diff --git a/share/functions/__fish_bind_test1.fish b/share/functions/__fish_bind_test1.fish index 37f5eeb0e..b4380c18f 100644 --- a/share/functions/__fish_bind_test1.fish +++ b/share/functions/__fish_bind_test1.fish @@ -3,13 +3,13 @@ function __fish_bind_test1 set -l args set -l use_keys no -for i in (commandline -poc) +for i in (commandline -poc) switch $i case -k --k --ke --key set use_keys yes case "-*" - + case "*" set args $args $i end diff --git a/share/functions/__fish_bind_test2.fish b/share/functions/__fish_bind_test2.fish index 8530451c0..4c7f684ac 100644 --- a/share/functions/__fish_bind_test2.fish +++ b/share/functions/__fish_bind_test2.fish @@ -4,7 +4,7 @@ set -l args for i in (commandline -poc) switch $i case "-*" - + case "*" set args $args $i end diff --git a/share/functions/__fish_commandline_test.fish b/share/functions/__fish_commandline_test.fish index af533eb2e..a32512cfb 100644 --- a/share/functions/__fish_commandline_test.fish +++ b/share/functions/__fish_commandline_test.fish @@ -2,7 +2,7 @@ function __fish_commandline_test set -l is_function no -for i in (commandline -poc) +for i in (commandline -poc) switch $i case -f --f --fu --fun --func --funct --functi --functio --function set is_function yes @@ -10,7 +10,7 @@ for i in (commandline -poc) case -- break - + end end diff --git a/share/functions/__fish_complete_ant_targets.fish b/share/functions/__fish_complete_ant_targets.fish index f8b286439..61dde00a6 100644 --- a/share/functions/__fish_complete_ant_targets.fish +++ b/share/functions/__fish_complete_ant_targets.fish @@ -8,7 +8,7 @@ function __fish_complete_ant_targets -d "Print list of targets from build.xml an set files (sed -n "s/^.*]* file=[\"']\([^\"']*\)[\"'].*\$/\1/p" < $buildfile) # iterate through files and display their targets - for file in $files; + for file in $files; __fish_filter_ant_targets $file end end diff --git a/share/functions/__fish_complete_cd.fish b/share/functions/__fish_complete_cd.fish index 1ca88af38..dbc7f766b 100644 --- a/share/functions/__fish_complete_cd.fish +++ b/share/functions/__fish_complete_cd.fish @@ -17,17 +17,17 @@ function __fish_complete_cd -d "Completions for the cd command" set mycdpath $CDPATH end - + if echo (commandline -ct)|sgrep '^/\|^\./\|^\.\./' >/dev/null # This is an absolute search path eval printf '\%s\\tDirectory\\n' (commandline -ct)\*/ else # This is a relative search path - # Iterate over every directory in CDPATH + # Iterate over every directory in CDPATH # and check for possible completions for i in $mycdpath - # Move to the initial directory first, + # Move to the initial directory first, # in case the CDPATH directory is relative builtin cd $wd diff --git a/share/functions/__fish_complete_file_url.fish b/share/functions/__fish_complete_file_url.fish index a85bd55c3..28af18080 100644 --- a/share/functions/__fish_complete_file_url.fish +++ b/share/functions/__fish_complete_file_url.fish @@ -12,7 +12,7 @@ function __fish_complete_file_url if test file:// = $prefix set -l stripped (echo $comp|cut -c 8-) - printf "%s\n" file://(complete -C"echo $stripped") + printf "%s\n" file://(complete -C"echo $stripped") else echo file:// end diff --git a/share/functions/__fish_complete_ls.fish b/share/functions/__fish_complete_ls.fish index ff3bf4e0a..652a02d37 100644 --- a/share/functions/__fish_complete_ls.fish +++ b/share/functions/__fish_complete_ls.fish @@ -5,14 +5,14 @@ # Test if we are using GNU ls function __fish_complete_ls -d "Compleletions for ls and its aliases" - - set -l is_gnu + + set -l is_gnu command ls --version >/dev/null ^/dev/null; and set is_gnu --is-gnu - + set -l cmds -c $argv - + # Shared ls switches - + __fish_gnu_complete $cmds -s a -l all --description "Show hidden" $is_gnu __fish_gnu_complete $cmds -s A -l almost-all --description "Show hidden except . and .." $is_gnu __fish_gnu_complete $cmds -s F -l classify --description "Append filetype indicator" $is_gnu @@ -28,7 +28,7 @@ function __fish_complete_ls -d "Compleletions for ls and its aliases" __fish_gnu_complete $cmds -s q -l hide-control-chars --description "Replace non-graphic characters with '?'" $is_gnu __fish_gnu_complete $cmds -s r -l reverse --description "Reverse sort order" $is_gnu __fish_gnu_complete $cmds -s s -l size --description "Print size of files" $is_gnu - + complete $cmds -s C --description "List by columns" complete $cmds -s S --description "Sort by size" complete $cmds -s c --description "Show and sort by ctime" @@ -41,11 +41,11 @@ function __fish_complete_ls -d "Compleletions for ls and its aliases" complete $cmds -s u --description "Show access time" complete $cmds -s x --description "List entries by lines" complete $cmds -s 1 --description "List one file per line" - + if test -n "$is_gnu" - + # GNU specific ls switches - + complete $cmds -l hide --description "Do not list implied entries matching specified shell pattern" -r complete $cmds -l lcontext --description "Display security context" complete $cmds -l context -s Z --description "Display security context so it fits on most displays" @@ -94,11 +94,11 @@ function __fish_complete_ls -d "Compleletions for ls and its aliases" complete $cmds -s X --description "Sort by extension" complete $cmds -l help --description "Display help and exit" complete $cmds -l version --description "Display version and exit" - + else - + # If not a GNU system, assume we have standard BSD ls features instead - + complete $cmds -s B --description "Octal escapes for non graphic characters" complete $cmds -s G --description "Use colors" complete $cmds -s I --description "Prevent -A from being automatically set for root" @@ -108,7 +108,7 @@ function __fish_complete_ls -d "Compleletions for ls and its aliases" complete $cmds -s Z --description "Display each file's MAC label" complete $cmds -s o --description "Include the file flags in a long (-l) output" complete $cmds -s w --description "Print raw entry names" - + end - + end diff --git a/share/functions/__fish_complete_man.fish b/share/functions/__fish_complete_man.fish index dad6ed0d8..7be041f0c 100644 --- a/share/functions/__fish_complete_man.fish +++ b/share/functions/__fish_complete_man.fish @@ -1,5 +1,5 @@ -function __fish_complete_man +function __fish_complete_man if test (commandline -ct) # Try to guess what section to search in. If we don't know, we @@ -11,13 +11,13 @@ function __fish_complete_man while count $prev switch $prev[1] case '-**' - + case '*' set section $prev[1] end set -e prev[1] end - + set section $section"[^)]*" # Do the actual search diff --git a/share/functions/__fish_complete_subcommand.fish b/share/functions/__fish_complete_subcommand.fish index 78803a88b..c002b8123 100644 --- a/share/functions/__fish_complete_subcommand.fish +++ b/share/functions/__fish_complete_subcommand.fish @@ -24,7 +24,7 @@ function __fish_complete_subcommand -d "Complete subcommand" switch $i case '-*' case '*=*' - + case '*' set had_cmd 1 set res $i diff --git a/share/functions/__fish_complete_subcommand_root.fish b/share/functions/__fish_complete_subcommand_root.fish index 49504ce4e..b6b2152e5 100644 --- a/share/functions/__fish_complete_subcommand_root.fish +++ b/share/functions/__fish_complete_subcommand_root.fish @@ -1,7 +1,7 @@ function __fish_complete_subcommand_root -d "Run the __fish_complete_subcommand function using a PATH containing /sbin and /usr/sbin" - set -l PATH_OLD $PATH + set -l PATH_OLD $PATH set PATH /sbin /usr/sbin $PATH __fish_complete_subcommand set PATH $PATH_OLD diff --git a/share/functions/__fish_complete_suffix.fish b/share/functions/__fish_complete_suffix.fish index 035911a76..5abdb2ffd 100644 --- a/share/functions/__fish_complete_suffix.fish +++ b/share/functions/__fish_complete_suffix.fish @@ -9,9 +9,9 @@ function __fish_complete_suffix -d "Complete using files" # Variable declarations - set -l comp - set -l suff - set -l desc + set -l comp + set -l suff + set -l desc set -l files switch (count $argv) diff --git a/share/functions/__fish_complete_tar.fish b/share/functions/__fish_complete_tar.fish index f19d6727f..91a795015 100644 --- a/share/functions/__fish_complete_tar.fish +++ b/share/functions/__fish_complete_tar.fish @@ -11,21 +11,21 @@ function __fish_complete_tar -d "Peek inside of archives and list all files" case '*.tar.bz' '*.tar.bz2' '*.tbz' '*.tbz2' if test -f $i set -l file_list (tar -jt <$i) - printf (_ "%s\tArchived file\n") $file_list + printf (_ "%s\tArchived file\n") $file_list end return case '*.tar.gz' '*.tgz' if test -f $i set -l file_list (tar -it <$i) - printf (_ "%s\tArchived file\n") $file_list + printf (_ "%s\tArchived file\n") $file_list end return case '*.tar' if test -f $i set -l file_list (tar -t <$i) - printf (_ "%s\tArchived file\n") $file_list + printf (_ "%s\tArchived file\n") $file_list end return end diff --git a/share/functions/__fish_complete_unrar.fish b/share/functions/__fish_complete_unrar.fish index b9a0fda16..1c86794e5 100644 --- a/share/functions/__fish_complete_unrar.fish +++ b/share/functions/__fish_complete_unrar.fish @@ -11,7 +11,7 @@ function __fish_complete_unrar -d "Peek inside of archives and list all files" case '*.rar' if test -f $i set -l file_list (unrar vb $i) - printf (_ "%s\tArchived file\n") $file_list + printf (_ "%s\tArchived file\n") $file_list end return end diff --git a/share/functions/__fish_complete_vi.fish b/share/functions/__fish_complete_vi.fish index 7b756f298..ba7dc10b5 100644 --- a/share/functions/__fish_complete_vi.fish +++ b/share/functions/__fish_complete_vi.fish @@ -4,13 +4,13 @@ function __fish_complete_vi -d "Compleletions for vi and its aliases" set -l is_vim command vi --version >/dev/null ^/dev/null; and set is_vim vim - + set -l cmds -c $argv # vim if test -n "$is_vim" - + # these don't work #complete $cmds -a - --description 'The file to edit is read from stdin. Commands are read from stderr, which should be a tty' @@ -105,7 +105,7 @@ function __fish_complete_vi -d "Compleletions for vi and its aliases" complete $cmds -r -c t --description 'Begin editing by executing the specified editor command' end - + end diff --git a/share/functions/__fish_config_interactive.fish b/share/functions/__fish_config_interactive.fish index 11ad98544..e2ace3f0c 100644 --- a/share/functions/__fish_config_interactive.fish +++ b/share/functions/__fish_config_interactive.fish @@ -32,8 +32,8 @@ function __fish_config_interactive -d "Initializations that should be performed end if test -d $configdir - if command mkdir $configdir/fish - + if command mkdir $configdir/fish + # These files are sometimes overwritten to by fish, so # we want backups of them in case something goes wrong @@ -51,7 +51,7 @@ function __fish_config_interactive -d "Initializations that should be performed # # Move the fishd stuff from another shell to avoid concurrency problems # - + /bin/sh -c mv\ \~/.fishd.(hostname)\ $configdir/fish/fishd.(hostname)\;kill\ -9\ (echo %fishd) # Update paths to point to new configuration locations @@ -70,12 +70,12 @@ function __fish_config_interactive -d "Initializations that should be performed # Make sure this is only done once set -U __fish_init_1_22_0 - + end # # If we are starting up for the first time, set various defaults - # + # if not set -q __fish_init_1_23_0 if not set -q fish_greeting @@ -91,7 +91,7 @@ function __fish_config_interactive -d "Initializations that should be performed function set_default -d "Set a universal variable, unless it has already been set" if not set -q $argv[1] - set -U -- $argv + set -U -- $argv end end @@ -139,11 +139,11 @@ function __fish_config_interactive -d "Initializations that should be performed # functions -e set_default - + end # - # Print a greeting + # Print a greeting # if functions -q fish_greeting @@ -153,7 +153,7 @@ function __fish_config_interactive -d "Initializations that should be performed switch $fish_greeting case '' # If variable is empty, don't print anything, saves us a fork - + case '*' echo $fish_greeting end @@ -189,7 +189,7 @@ function __fish_config_interactive -d "Initializations that should be performed end # - # Completions for SysV startup scripts. These aren't bound to any + # Completions for SysV startup scripts. These aren't bound to any # specific command, so they can't be autoloaded. # @@ -203,11 +203,11 @@ function __fish_config_interactive -d "Initializations that should be performed if not set -q fish_key_bindings set -U fish_key_bindings fish_default_key_bindings end - + # Reload keybindings when binding variable change function __fish_reload_key_bindings -d "Reload keybindings when binding variable change" --on-variable fish_key_bindings eval $fish_key_bindings ^/dev/null - end + end # Load keybindings __fish_reload_key_bindings @@ -220,11 +220,11 @@ function __fish_config_interactive -d "Initializations that should be performed # If the ubuntu command-not-found package can be found, add a handler for it # First check in /usr/lib, this is where modern Ubuntus place this command - if test -f /usr/lib/command-not-found + if test -f /usr/lib/command-not-found function fish_command_not_found_handler --on-event fish_command_not_found /usr/lib/command-not-found $argv end - else + else # Ubuntu Feisty places this command in the regular path instead if type -p command-not-found >/dev/null function fish_command_not_found_handler --on-event fish_command_not_found diff --git a/share/functions/__fish_contains_opt.fish b/share/functions/__fish_contains_opt.fish index f38adb40c..b786fe3be 100644 --- a/share/functions/__fish_contains_opt.fish +++ b/share/functions/__fish_contains_opt.fish @@ -1,13 +1,13 @@ function __fish_contains_opt -d "Checks if a specific option has been given in the current commandline" - set -l next_short + set -l next_short set -l short_opt - set -l long_opt + set -l long_opt for i in $argv - if test $next_short - set next_short + if test $next_short + set next_short set short_opt $short_opt $i else switch $i @@ -32,7 +32,7 @@ function __fish_contains_opt -d "Checks if a specific option has been given in t if commandline -cpo | sgrep -- "^-"$i"\|^-[^-]*"$i >/dev/null return 0 end - + if commandline -ct | sgrep -- "^-"$i"\|^-[^-]*"$i >/dev/null return 0 end diff --git a/share/functions/__fish_crux_packages.fish b/share/functions/__fish_crux_packages.fish index 8cd88f4a2..fa96e4803 100644 --- a/share/functions/__fish_crux_packages.fish +++ b/share/functions/__fish_crux_packages.fish @@ -1,4 +1,4 @@ -# a function to obtain a list of installed packages with CRUX pkgutils +# a function to obtain a list of installed packages with CRUX pkgutils function __fish_crux_packages -d 'Obtain a list of installed packages' pkginfo -i|cut -d' ' -f1 end diff --git a/share/functions/__fish_gnu_complete.fish b/share/functions/__fish_gnu_complete.fish index 47885845f..ae8009403 100644 --- a/share/functions/__fish_gnu_complete.fish +++ b/share/functions/__fish_gnu_complete.fish @@ -6,7 +6,7 @@ function __fish_gnu_complete -d "Wrapper for the complete builtin. Skips the lon # Check if we are using a gnu system for i in $argv switch $i - + case -g --is-gnu set is_gnu 1 @@ -31,7 +31,7 @@ function __fish_gnu_complete -d "Wrapper for the complete builtin. Skips the lon continue end - + switch $i case -l --long @@ -45,7 +45,7 @@ function __fish_gnu_complete -d "Wrapper for the complete builtin. Skips the lon set argv $argv_out end - + complete $argv end diff --git a/share/functions/__fish_move_last.fish b/share/functions/__fish_move_last.fish index b4a70f8c0..c1d060439 100644 --- a/share/functions/__fish_move_last.fish +++ b/share/functions/__fish_move_last.fish @@ -14,14 +14,14 @@ function __fish_move_last -d "Move the last element of a directory history from set -g (echo $dest) $$dest (command pwd) set ssrc $$src - + # Change dir to the last entry in the source dir-hist builtin cd $ssrc[$size_src] - # Keep all but the last from the source dir-hist + # Keep all but the last from the source dir-hist set -e (echo $src)\[$size_src] # All ok, return success return 0 -end +end diff --git a/share/functions/__fish_no_arguments.fish b/share/functions/__fish_no_arguments.fish index e47a42726..b2ce27814 100644 --- a/share/functions/__fish_no_arguments.fish +++ b/share/functions/__fish_no_arguments.fish @@ -5,7 +5,7 @@ function __fish_no_arguments -d "Internal fish function" for i in $cmd switch $i case '-*' - + case '*' return 1 end diff --git a/share/functions/__fish_not_contain_opt.fish b/share/functions/__fish_not_contain_opt.fish index 0a7e0f561..8320607f2 100644 --- a/share/functions/__fish_not_contain_opt.fish +++ b/share/functions/__fish_not_contain_opt.fish @@ -1,12 +1,12 @@ function __fish_not_contain_opt -d "Checks that a specific option is not in the current commandline" - set -l next_short + set -l next_short set -l short_opt - set -l long_opt + set -l long_opt for i in $argv - if test $next_short - set next_short + if test $next_short + set next_short set short_opt $short_opt $i else switch $i @@ -31,7 +31,7 @@ function __fish_not_contain_opt -d "Checks that a specific option is not in the if commandline -cpo | sgrep -- "^-"$i"\|^-[^-]*"$i >/dev/null return 1 end - + if commandline -ct | sgrep -- "^-"$i"\|^-[^-]*"$i >/dev/null return 1 end diff --git a/share/functions/__fish_paginate.fish b/share/functions/__fish_paginate.fish index 992993b6c..01708f9cd 100644 --- a/share/functions/__fish_paginate.fish +++ b/share/functions/__fish_paginate.fish @@ -6,7 +6,7 @@ function __fish_paginate -d "Paginate the current command using the users defaul end if commandline -j|grep -v "$cmd *\$" >/dev/null - + commandline -aj "|$cmd;" end diff --git a/share/functions/__fish_print_filesystems.fish b/share/functions/__fish_print_filesystems.fish index 0eeea3c81..d7222f833 100644 --- a/share/functions/__fish_print_filesystems.fish +++ b/share/functions/__fish_print_filesystems.fish @@ -1,8 +1,8 @@ function __fish_print_filesystems -d "Print a list of all known filesystem types" - set -l fs adfs affs autofs coda coherent cramfs devpts efs ext ext2 ext3 - set fs $fs hfs hpfs iso9660 jfs minix msdos ncpfs nfs ntfs proc qnx4 ramfs + set -l fs adfs affs autofs coda coherent cramfs devpts efs ext ext2 ext3 + set fs $fs hfs hpfs iso9660 jfs minix msdos ncpfs nfs ntfs proc qnx4 ramfs set fs $fs reiserfs romfs smbfs sysv tmpfs udf ufs umsdos vfat xenix xfs xiafs - printf "%s\n" $fs + printf "%s\n" $fs end diff --git a/share/functions/__fish_print_help.fish b/share/functions/__fish_print_help.fish index f6022a575..b213c8811 100644 --- a/share/functions/__fish_print_help.fish +++ b/share/functions/__fish_print_help.fish @@ -20,7 +20,7 @@ function __fish_print_help --description "Print help message for the specified f set -l cmd3 s/.\x08'\(.\)'/(set_color --bold)\\1(set_color normal)/g # Combine all expressions in a single variable - set -l sed_cmd -e $cmd1 -e $cmd2 -e $cmd3 + set -l sed_cmd -e $cmd1 -e $cmd2 -e $cmd3 # Render help output, save output into the variable 'help' set -l help (nroff -man $__fish_datadir/man/$item.1) diff --git a/share/functions/__fish_print_packages.fish b/share/functions/__fish_print_packages.fish index fb24ffff2..8dae87b91 100644 --- a/share/functions/__fish_print_packages.fish +++ b/share/functions/__fish_print_packages.fish @@ -25,12 +25,12 @@ function __fish_print_packages # Rpm is too slow for this job, so we set it up to do completions # as a background job and cache the results. - if type -f rpm >/dev/null + if type -f rpm >/dev/null # If the cache is less than five minutes old, we do not recalculate it set cache_file /tmp/.rpm-cache.$USER - if test -f $cache_file + if test -f $cache_file cat $cache_file set age (math (date +%s) - (stat -c '%Y' $cache_file)) set max_age 250 @@ -43,8 +43,8 @@ function __fish_print_packages rpm -qa >$cache_file |sed -e 's/-[^-]*-[^-]*$//' | sed -e 's/$/'\t$package'/' & end - # This completes the package name from the portage tree. - # True for installing new packages. Function for printing + # This completes the package name from the portage tree. + # True for installing new packages. Function for printing # installed on the system packages is in completions/emerge.fish if type -f emerge >/dev/null emerge -s \^(commandline -tc) |sgrep "^*" |cut -d\ -f3 |cut -d/ -f2 diff --git a/share/functions/__fish_prt_use_package.fish b/share/functions/__fish_prt_use_package.fish index edb2e7f7e..b7c480342 100644 --- a/share/functions/__fish_prt_use_package.fish +++ b/share/functions/__fish_prt_use_package.fish @@ -1,7 +1,7 @@ # a function to verify if prt-get should have packages as potential completion function __fish_prt_use_package -d 'Test if prt-get should have packages as potential completion' for i in (commandline -opc) - if contains -- $i update remove lock unlock current + if contains -- $i update remove lock unlock current return 0 end end diff --git a/share/functions/cd.fish b/share/functions/cd.fish index 64ac705d2..8faa469d7 100644 --- a/share/functions/cd.fish +++ b/share/functions/cd.fish @@ -21,7 +21,7 @@ function cd --description "Change directory" end return $status end - + builtin cd $argv[1] set -l cd_status $status diff --git a/share/functions/dirh.fish b/share/functions/dirh.fish index 411a2816a..582017678 100644 --- a/share/functions/dirh.fish +++ b/share/functions/dirh.fish @@ -1,5 +1,5 @@ -function dirh --description "Print the current directory history (the back- and fwd- lists)" +function dirh --description "Print the current directory history (the back- and fwd- lists)" if count $argv >/dev/null switch $argv[1] @@ -25,7 +25,7 @@ function dirh --description "Print the current directory history (the back- and set_color $fish_color_history_current echo -n -e $current$separator set_color normal - + for i in (seq (echo (count $dirnext)) -1 1) echo -n -e $dirnext[$i]$separator end diff --git a/share/functions/down-or-search.fish b/share/functions/down-or-search.fish index c9e8b256a..3f775bfbf 100644 --- a/share/functions/down-or-search.fish +++ b/share/functions/down-or-search.fish @@ -6,7 +6,7 @@ function down-or-search -d "Depending on cursor position and current mode, eithe end # We are not already in search mode. - # If we are on the bottom line, start search mode, + # If we are on the bottom line, start search mode, # otherwise move down set lineno (commandline -L) set line_count (commandline|wc -l) @@ -14,7 +14,7 @@ function down-or-search -d "Depending on cursor position and current mode, eithe switch $lineno case $line_count commandline -f history-search-forward - + case '*' commandline -f down-line end diff --git a/share/functions/fish_default_key_bindings.fish b/share/functions/fish_default_key_bindings.fish index 60fefc3b8..f8e1edf49 100644 --- a/share/functions/fish_default_key_bindings.fish +++ b/share/functions/fish_default_key_bindings.fish @@ -3,7 +3,7 @@ function fish_default_key_bindings -d "Default (Emacs-like) key bindings for fis # Clear earlier bindings, if any bind --erase --all - + # This is the default binding, i.e. the one used if no other binding matches bind "" self-insert @@ -12,28 +12,28 @@ function fish_default_key_bindings -d "Default (Emacs-like) key bindings for fis bind \ck kill-line bind \cy yank bind \t complete - + bind \e\n "commandline -i \n" - + bind \e\[A up-or-search bind \e\[B down-or-search bind -k down down-or-search bind -k up up-or-search - + bind \e\[C forward-char bind \e\[D backward-char bind -k right forward-char bind -k left backward-char - + bind -k dc delete-char bind -k backspace backward-delete-char bind \x7f backward-delete-char - + bind \e\[H beginning-of-line bind \e\[F end-of-line bind -k home beginning-of-line bind -k end end-of-line - + bind \e\eOC nextd-or-forward-word bind \e\eOD prevd-or-backward-word bind \e\e\[C nextd-or-forward-word @@ -43,8 +43,8 @@ function fish_default_key_bindings -d "Default (Emacs-like) key bindings for fis bind \e\[3C nextd-or-forward-word bind \e\[3D prevd-or-backward-word bind \e\[1\;3C nextd-or-forward-word - bind \e\[1\;3D prevd-or-backward-word - + bind \e\[1\;3D prevd-or-backward-word + bind \e\eOA history-token-search-backward bind \e\eOB history-token-search-forward bind \e\e\[A history-token-search-backward @@ -55,7 +55,7 @@ function fish_default_key_bindings -d "Default (Emacs-like) key bindings for fis bind \e\[3B history-token-search-forward bind \e\[1\;3A history-token-search-backward bind \e\[1\;3B history-token-search-forward - + bind \ca beginning-of-line bind \ce end-of-line bind \ey yank-pop @@ -73,17 +73,17 @@ function fish_default_key_bindings -d "Default (Emacs-like) key bindings for fis bind -k npage end-of-history bind \e\< beginning-of-buffer bind \e\> end-of-buffer - + bind \el __fish_list_current_token bind \ew 'set tok (commandline -pt); if test $tok[1]; whatis $tok[1]; commandline -f repaint; end' bind \cl 'clear; commandline -f repaint' bind \cc 'commandline ""' bind \cu backward-kill-line bind \ed kill-word - bind \cw backward-kill-word + bind \cw backward-kill-word bind \ed 'if test -z (commandline); dirh; commandline -f repaint; else; commandline -f kill-word; end' bind \cd delete-or-exit - + # This will make sure the output of the current command is paged using the less pager when you press Meta-p bind \ep '__fish_paginate' diff --git a/share/functions/funced.fish b/share/functions/funced.fish index dca73d702..5bd54acdd 100644 --- a/share/functions/funced.fish +++ b/share/functions/funced.fish @@ -14,22 +14,22 @@ function funced --description "Edit function definition" case '*' set -l init '' set -l tmp - + # Shadow IFS here to avoid array splitting in command substitution - set -l IFS + set -l IFS if functions -q $argv set init (functions $argv | fish_indent --no-indent) else set init function $argv\nend end - + set -l prompt 'printf "%s%s%s> " (set_color green) '$argv' (set_color normal)' # Unshadow IFS since the fish_title breaks otherwise set -e IFS if read -p $prompt -c "$init" -s cmd # Shadow IFS _again_ to avoid array splitting in command substitution - set -l IFS + set -l IFS eval (echo -n $cmd | fish_indent) end return 0 diff --git a/share/functions/grep.fish b/share/functions/grep.fish index 60e83b204..b0dc9586c 100644 --- a/share/functions/grep.fish +++ b/share/functions/grep.fish @@ -3,10 +3,10 @@ # if command grep --color=auto --help 1>/dev/null 2>/dev/null - if not set -q GREP_COLOR + if not set -q GREP_COLOR set -gx GREP_COLOR '97;45' end - if not set -q GREP_OPTIONS + if not set -q GREP_OPTIONS set -gx GREP_OPTIONS --color=auto end end diff --git a/share/functions/help.fish b/share/functions/help.fish index 0234757f7..bd5360026 100644 --- a/share/functions/help.fish +++ b/share/functions/help.fish @@ -14,9 +14,9 @@ function help --description "Show help for the fish shell" set -l fish_browser_bg set -l h syntax completion editor job-control todo bugs history killring help - set h $h color prompt title variables builtin-overview changes expand - set h $h expand-variable expand-home expand-brace expand-wildcard - set -l help_topics $h expand-command-substitution expand-process + set h $h color prompt title variables builtin-overview changes expand + set h $h expand-variable expand-home expand-brace expand-wildcard + set -l help_topics $h expand-command-substitution expand-process # 'help -h' should launch 'help help' if count $argv >/dev/null diff --git a/share/functions/isatty.fish b/share/functions/isatty.fish index 1603972f1..d4f2c43e3 100644 --- a/share/functions/isatty.fish +++ b/share/functions/isatty.fish @@ -1,7 +1,7 @@ function isatty -d "Tests if a file descriptor is a tty" set -l fd 0 - if count $argv >/dev/null + if count $argv >/dev/null switch $argv[1] case -h --h --he --hel --help @@ -19,7 +19,7 @@ function isatty -d "Tests if a file descriptor is a tty" case '*' set fd $argv[1] - + end end diff --git a/share/functions/math.fish b/share/functions/math.fish index f25793816..bad349d93 100644 --- a/share/functions/math.fish +++ b/share/functions/math.fish @@ -16,6 +16,6 @@ function math --description "Perform math calculations in bc" return 0 end return 2 - + end diff --git a/share/functions/nextd.fish b/share/functions/nextd.fish index 9b65b7567..80d7c42aa 100644 --- a/share/functions/nextd.fish +++ b/share/functions/nextd.fish @@ -10,7 +10,7 @@ function nextd --description "Move forward in the directory history" end # Parse arguments - set -l show_hist 0 + set -l show_hist 0 set -l times 1 for i in (seq (count $argv)) switch $argv[$i] @@ -56,4 +56,4 @@ function nextd --description "Move forward in the directory history" # All done return $code -end +end diff --git a/share/functions/prevd.fish b/share/functions/prevd.fish index d0f546a22..c0361e1ff 100644 --- a/share/functions/prevd.fish +++ b/share/functions/prevd.fish @@ -10,7 +10,7 @@ function prevd --description "Move back in the directory history" end # Parse arguments - set -l show_hist 0 + set -l show_hist 0 set -l times 1 for i in (seq (count $argv)) switch $argv[$i] @@ -56,5 +56,5 @@ function prevd --description "Move back in the directory history" # All done return $code -end +end diff --git a/share/functions/prompt_pwd.fish b/share/functions/prompt_pwd.fish index 46b4935a7..7f892c700 100644 --- a/share/functions/prompt_pwd.fish +++ b/share/functions/prompt_pwd.fish @@ -10,7 +10,7 @@ if test (uname) = Darwin end else function prompt_pwd --description "Print the current working directory, shortend to fit the prompt" - switch "$PWD" + switch "$PWD" case "$HOME" echo '~' diff --git a/share/functions/psub.fish b/share/functions/psub.fish index 9eebd13bb..874d58320 100644 --- a/share/functions/psub.fish +++ b/share/functions/psub.fish @@ -9,7 +9,7 @@ function psub --description "Read from stdin into a file and output the filename set -l longopt -l help,file if getopt -T >/dev/null - set longopt + set longopt end if not getopt -n psub -Q $shortopt $longopt -- $argv @@ -57,7 +57,7 @@ function psub --description "Read from stdin into a file and output the filename # Write output to pipe. This needs to be done in the background so # that the command substitution exits without needing to wait for # all the commands to exit - mkfifo $filename + mkfifo $filename cat >$filename & else cat >$filename @@ -75,6 +75,6 @@ function psub --description "Read from stdin into a file and output the filename end # Make sure we erase file when caller exits - eval function $funcname --on-job-exit caller\; command rm $filename\; functions -e $funcname\; end + eval function $funcname --on-job-exit caller\; command rm $filename\; functions -e $funcname\; end end diff --git a/share/functions/pwd.fish b/share/functions/pwd.fish index d51fe5c61..22745406f 100644 --- a/share/functions/pwd.fish +++ b/share/functions/pwd.fish @@ -3,7 +3,7 @@ # Also drop '/private' directories on OS X. # -switch (uname) +switch (uname) case Darwin function pwd --description "Print working directory" diff --git a/share/functions/trap.fish b/share/functions/trap.fish index ee29aa784..514dc9767 100644 --- a/share/functions/trap.fish +++ b/share/functions/trap.fish @@ -13,18 +13,18 @@ function __trap_switch switch $argv[1] case EXIT echo --on-exit %self - + case '*' echo --on-signal $argv[1] - end + end end function trap -d 'Perform an action when the shell recives a signal' set -l mode - set -l cmd - set -l sig + set -l cmd + set -l sig set -l shortopt set -l longopt @@ -47,13 +47,13 @@ function trap -d 'Perform an action when the shell recives a signal' case -h --help __fish_print_help trap return 0 - + case -p --print set mode print - + case -l --list-signals set mode list - + case -- set -e opt[1] break @@ -87,7 +87,7 @@ function trap -d 'Perform an action when the shell recives a signal' for i in $opt set sig (__trap_translate_signal $i) if test $sig - functions -e __trap_handler_$sig + functions -e __trap_handler_$sig end end @@ -108,7 +108,7 @@ function trap -d 'Perform an action when the shell recives a signal' end case print - set -l names + set -l names if count $opt >/dev/null set names $opt @@ -130,7 +130,7 @@ function trap -d 'Perform an action when the shell recives a signal' case list kill -l - + end end diff --git a/share/functions/type.fish b/share/functions/type.fish index a9b1bdffd..66b72ae3e 100644 --- a/share/functions/type.fish +++ b/share/functions/type.fish @@ -28,14 +28,14 @@ function type --description "Print the type of a command" switch $i case -t --type set mode type - + case -p --path set mode path - - case -P --force-path + + case -P --force-path set mode path set selection files - + case -a --all set selection multi @@ -54,7 +54,7 @@ function type --description "Print the type of a command" # Check all possible types for the remaining arguments for i in $argv - + switch $i case '-*' continue diff --git a/share/functions/umask.fish b/share/functions/umask.fish index 319ce9ac3..d6e0bdde9 100644 --- a/share/functions/umask.fish +++ b/share/functions/umask.fish @@ -4,7 +4,7 @@ function __fish_umask_parse -d "Internal umask function" if echo $argv | sgrep -E '^(0|)[0-7]{1,3}$' >/dev/null set -l char_count (echo $argv| wc -c) for i in (seq (math 5 - $char_count)); set argv 0$argv; end - echo $argv + echo $argv else # Test if argument really is a valid symbolic mask if not echo $argv | sgrep -E '^(((u|g|o|a|)(=|\+|-)|)(r|w|x)*)(,(((u|g|o|a|)(=|\+|-)|)(r|w|x)*))*$' >/dev/null @@ -26,7 +26,7 @@ function __fish_umask_parse -d "Internal umask function" set -l char_count (echo $tmp|cut -c 1) set res[$i] (math 7 - $char_count) end - + set -l el (echo $argv|tr , \n) for i in $el switch $i @@ -54,15 +54,15 @@ function __fish_umask_parse -d "Internal umask function" switch $i case '=*' set mode set - set i (echo $i| cut -c 2-) + set i (echo $i| cut -c 2-) case '+*' set mode add - set i (echo $i| cut -c 2-) + set i (echo $i| cut -c 2-) case '-*' set mode remove - set i (echo $i| cut -c 2-) + set i (echo $i| cut -c 2-) case '*' if not count $implicit_all >/dev/null @@ -120,7 +120,7 @@ function __fish_umask_print_symbolic if contains $val 0 1 2 3 set res {$res}r end - + if contains $val 0 1 4 5 set res {$res}w end @@ -161,7 +161,7 @@ function umask --description "Set default file permission mask" return 0 case -p --as-command - set as_command 1 + set as_command 1 case -S --symbolic set symbolic 1 diff --git a/share/functions/up-or-search.fish b/share/functions/up-or-search.fish index 18c37e836..fc51d7106 100644 --- a/share/functions/up-or-search.fish +++ b/share/functions/up-or-search.fish @@ -6,14 +6,14 @@ function up-or-search -d "Depending on cursor position and current mode, either end # We are not already in search mode. - # If we are on the top line, start search mode, + # If we are on the top line, start search mode, # otherwise move up set lineno (commandline -L) switch $lineno case 1 commandline -f history-search-backward - + case '*' commandline -f up-line end diff --git a/tests/gen_output.fish b/tests/gen_output.fish index 91db67b06..49e15bfdc 100755 --- a/tests/gen_output.fish +++ b/tests/gen_output.fish @@ -3,7 +3,7 @@ # # Generate output for a test script # -# It is important that you verify that the generated +# It is important that you verify that the generated # output is correct! # diff --git a/tests/test.fish b/tests/test.fish index 082db4686..74e562b97 100755 --- a/tests/test.fish +++ b/tests/test.fish @@ -1,7 +1,7 @@ #!/usr/local/bin/fish # # Main loop of the test suite. I wrote this -# instad of using autotest to provide additional +# instad of using autotest to provide additional # testing for fish. :-) echo Testing high level script functionality diff --git a/tests/test1.in b/tests/test1.in index 5b87fb719..3b3ba25f3 100644 --- a/tests/test1.in +++ b/tests/test1.in @@ -3,7 +3,7 @@ # for i in 1 2 #Comment on same line as command -#Comment inside loop +#Comment inside loop for j in a b #Double loop echo $i$j @@ -12,7 +12,7 @@ end # Simple alias tests -function foo +function foo echo >foo.txt $argv end @@ -26,16 +26,16 @@ else echo Test 2 fail end -function foo +function foo printf 'Test %s' $1; echo ' pass' end -foo 3 +foo 3 for i in Test for continue break and switch builtins problems; switch $i case Test - printf "%s " $i + printf "%s " $i case "f??" printf "%s " 3 case "c*" diff --git a/tests/test2.in b/tests/test2.in index a0c7ecbd9..2a5ce81ee 100644 --- a/tests/test2.in +++ b/tests/test2.in @@ -1,4 +1,4 @@ -#Tests complex parameter expantions +#Tests complex parameter expantions set a A set aa AA diff --git a/tests/test3.in b/tests/test3.in index 4b26d7871..c6801999e 100644 --- a/tests/test3.in +++ b/tests/test3.in @@ -62,9 +62,9 @@ end # Test that scope is preserved in double blocks -for i in 1 +for i in 1 set t6 $i - for j in a + for j in a if test $t6$j = 1a echo Test 6 pass else @@ -105,7 +105,7 @@ end # Test if exported variables go out of scope -if test (../fish -c "echo $t8") +if test (../fish -c "echo $t8") echo Test 9 fail else echo Test 9 pass diff --git a/tests/test4.in b/tests/test4.in index 0966694aa..4155c0e86 100644 --- a/tests/test4.in +++ b/tests/test4.in @@ -2,30 +2,30 @@ set -e smurf -function setter +function setter set smurf green end -function unsetter +function unsetter set -e smurf end -function call1 +function call1 set smurf blue; setter; if test $smurf = blue; echo Test 1 pass; else; echo Test 1 fail; end end -function call2 +function call2 set smurf blue; unsetter; if test $smurf = blue; echo Test 2 pass; else; echo Test 2 fail; end end call1 call2 -function call3 +function call3 setter; if test $smurf = green; echo Test 3 pass; else; echo Test 3 fail; end end -function call4 +function call4 unsetter; if not set -q smurf; echo Test 4 pass; else; echo Test 4 fail; end end diff --git a/user_doc.head.html b/user_doc.head.html index 342bf99b2..6a7684953 100644 --- a/user_doc.head.html +++ b/user_doc.head.html @@ -32,9 +32,9 @@ H4
    - fish home + fish home | - Main documentation page + Main documentation page | Design document | @@ -43,6 +43,6 @@ H4 FAQ | License - +