addons/TagHighlight/plugin/TagHighlight/data/options.txt

   1 #####################
   2 # Vim-only options: #
   3 #####################
   4
   5 language_detection_method:
   6         VimOptionMap:LanguageDetectionMethods
   7         Type:list
   8         Default:Extension
   9         Help:Specify methods to use for determining language for the file when reading highlight definitions.
  10
  11 filetype_language_overrides:
  12         VimOptionMap:FileTypeLanguageOverrides
  13         Type:dict
  14         Default:{}
  15         Help:Match file types to languages manually (if FileType language detection method is enabled).
  16
  17 extension_language_overrides:
  18         VimOptionMap:ExtensionLanguageOverrides
  19         Type:dict
  20         Default:{}
  21         Help:Match extensions to languages manually (if Extension language detection method is enabled).
  22
  23 syntax_language_overrides:
  24         VimOptionMap:SyntaxLanguageOverrides
  25         Type:dict
  26         Default:{}
  27         Help:Match syntaxes to languages manually (if Syntax language detection method is enabled).
  28
  29 disable_type_parsing:
  30         VimOptionMap:DisableTypeParsing
  31         Type:bool
  32         Default:False
  33         Help:Do not read types when opening a file
  34
  35 parsing_skip_list:
  36         VimOptionMap:ParsingSkipList
  37         Type:list
  38         Default:[]
  39         Help:List of files for which the type reading should be disabled
  40
  41 def_dir_mode_priority:
  42         VimOptionMap:DefaultDirModePriority
  43         Type:list
  44         Default:[]
  45         Help:List of methods (in order) to use when searching for tags/types etc
  46         Note:Default is overridden in TagHighlight#Option#GetOption()
  47
  48 max_dir_search_levels:
  49         VimOptionMap:MaxDirSearchLevels
  50         Type:int
  51         Default:0
  52         Help:How far up to search in UpFromFile or UpFromCurrent mode
  53
  54 config_file_name:
  55         VimOptionMap:ProjectConfigFileName
  56         Type:string
  57         Default:taghl_config.txt
  58         Help:File name for project specific configuration items
  59
  60 tag_dir_mode_priority:
  61         VimOptionMap:TagFileDirModePriority
  62         Type:list
  63         Default:Default
  64         Help:Optional override for dir mode priority for tag files specifically
  65
  66 types_dir_mode_priority:
  67         VimOptionMap:TypesFileDirModePriority
  68         Type:list
  69         Default:Default
  70         Help:Optional override for dir mode priority for types files specifically
  71
  72 config_dir_mode_priority:
  73         VimOptionMap:ProjectConfigFileDirModePriority
  74         Type:list
  75         Default:Default
  76         Help:Optional override for dir mode priority for project config files specifically
  77
  78 tag_file_directory:
  79         VimOptionMap:TagFileDirectory
  80         Type:string
  81         Default:None
  82         Help:Explicitly specified location for tag file (corresponding to Explicit search mode)
  83
  84 disable_tag_manager:
  85         VimOptionMap:DisableTagManager
  86         Type:bool
  87         Default:False
  88         Help:Disable automatic management of tags option
  89
  90 types_file_directory:
  91         VimOptionMap:TypesFileDirectory
  92         Type:string
  93         Default:None
  94         Help:Explicitly specified location for types file (corresponding to Explicit search mode)
  95
  96 config_file_directory:
  97         VimOptionMap:ProjectConfigFileDirectory
  98         Type:string
  99         Default:None
 100         Help:Explicitly specified location for project config file (corresponding to Explicit search mode)
 101
 102 default_dir_mode_search_wildcards:
 103         VimOptionMap:DefaultDirModeSearchWildcards
 104         Type:list
 105         Default:OPT(TagFileName),OPT(ProjectConfigFileName)
 106         Help:When searching directories, wildcards to match against (if any matches, we'll use this directory)
 107
 108 config_dir_mode_search_wildcards:
 109         VimOptionMap:ProjectConfigFileSearchWildcards
 110         Type:list
 111         Default:Default
 112         Help:When searching directories for project config files, wildcards to match against (if any matches, we'll use this directory)
 113
 114 tag_dir_mode_search_wildcards:
 115         VimOptionMap:TagFileSearchWildcards
 116         Type:list
 117         Default:Default
 118         Help:When searching directories for tag files, wildcards to match against (if any matches, we'll use this directory)
 119
 120 types_dir_mode_search_wildcards:
 121         VimOptionMap:TypesFileSearchWildcards
 122         Type:list
 123         Default:Default
 124         Help:When searching directories for types files, wildcards to match against (if any matches, we'll use this directory)
 125
 126 ctags_executable:
 127         VimOptionMap:CtagsExecutable
 128         Type:string
 129         Default:None
 130         Help:Name of the ctags executable, or full path to it
 131
 132 forced_python_variant:
 133         VimOptionMap:ForcedPythonVariant
 134         Type:string
 135         Default:None
 136         Help:Force the use of a specific variant (see help for PythonVariantPriority)
 137
 138 python_variant_priority:
 139         VimOptionMap:PythonVariantPriority
 140         Type:list
 141         Default:if_pyth3,if_pyth,python,compiled
 142         Help:Search order for deciding which variant to use
 143
 144 path_to_python:
 145         VimOptionMap:PathToPython
 146         Type:string
 147         Default:None
 148         Help:Location of the python executable or None to search the path
 149
 150 pre_read_hooks:
 151         VimOptionMap:PreReadHooks
 152         Type:list
 153         Default:[]
 154         Help:List of function names to run before reading types.
 155
 156 post_read_hooks:
 157         VimOptionMap:PostReadHooks
 158         Type:list
 159         Default:[]
 160         Help:List of function names to run after reading types.
 161
 162 pre_update_hooks:
 163         VimOptionMap:PreUpdateHooks
 164         Type:list
 165         Default:[]
 166         Help:List of function names to run before updating types.
 167
 168 post_update_hooks:
 169         VimOptionMap:PostUpdateHooks
 170         Type:list
 171         Default:[]
 172         Help:List of function names to run after updating types.
 173
 174 hooks:
 175         VimOptionMap:Hooks
 176         Type:dict
 177         Default:{'PreUpdate': [], 'PostUpdate': [], 'PreRead': [], 'PostRead': []}
 178         Help:Hooks dictionary (each entry is a list of strings containing functions to call; read functions take current file name and types suffix as parameters).
 179
 180 forced_standard_libraries:
 181         VimOptionMap:ForcedStandardLibraries
 182         Type:list
 183         Default:[]
 184         Help:List of standard libraries which we should load regardless of whether the matchers match (as long as suffix is correct).
 185
 186 disable_standard_libraries:
 187         VimOptionMap:DisableStandardLibraries
 188         Type:bool
 189         Default:False
 190         Help:Don't try to load standard libraries.
 191
 192 user_libraries:
 193         VimOptionMap:UserLibraries
 194         Type:list
 195         Default:[]
 196         Help:List of user libraries to load (either relative to UserLibraryDir or absolute).
 197
 198 user_library_dir:
 199         VimOptionMap:UserLibraryDir
 200         Type:string
 201         Default:.
 202         Help:Location of user libraries that are specified with relative paths.
 203
 204 use_existing_tagfile_if_present:
 205         VimOptionMap:DoNotGenerateTagsIfPresent
 206         Type:bool
 207         Default:False
 208         Help:Do not generate tags if a tag file already exists.
 209
 210 only_generate_types_if_present:
 211         VimOptionMap:OnlyGenerateTypesIfPresent
 212         Type:bool
 213         Default:False
 214         Help:Only generate tags/types if a types file already exists.
 215
 216 ##########################
 217 # Python script options: #
 218 ##########################
 219
 220 debug_level:
 221         CommandLineSwitches:--debug
 222         VimOptionMap:DebugLevel
 223         Type:string
 224         Default:Error
 225         Help:Debug level for printing (how much debug output to produce)
 226
 227 debug_file:
 228         CommandLineSwitches:--debug-file
 229         VimOptionMap:DebugFile
 230         Type:string
 231         Default:None
 232         Help:Debug log file into which messages should be stored
 233
 234 debug_print_time:
 235         CommandLineSwitches:--print-time-with-debug
 236         VimOptionMap:DebugPrintTime
 237         Type:bool
 238         Default:False
 239         Help:Print the time with each debug message in the log
 240
 241 source_root:
 242         CommandLineSwitches:-d,--source-root
 243         VimOptionMap:SourceDir
 244         Type:string
 245         Default:None
 246         Help:Location of source files to scan
 247
 248 recurse:
 249         CommandLineSwitches:--no-recurse
 250         VimOptionMap:Recurse
 251         Type:bool
 252         Default:True
 253         Help:Recurse into subdirectories
 254
 255 ctags_file:
 256         CommandLineSwitches:--ctags-file
 257         VimOptionMap:TagFileName
 258         Type:string
 259         Default:tags
 260         Help:CTAGS output filename
 261
 262 ctags_file_dir:
 263         CommandLineSwitches:--ctags-file-dir
 264         VimOptionMap:CtagsFileLocation
 265         Type:string
 266         Default:.
 267         Help:Location in which to store or find CTAGS output file
 268
 269 types_file_name_override:
 270         CommandLineSwitches:--types-file-name-override
 271         VimOptionMap:TypesFileNameForce
 272         Type:string
 273         Default:None
 274         Help:Force types filename to be a specific string (as opposed to prefix + _ + suffix + . + extension).
 275
 276 types_file_prefix:
 277         CommandLineSwitches:--types-file-prefix
 278         VimOptionMap:TypesFilePrefix
 279         Type:string
 280         Default:types
 281         Help:Vim Types file prefix
 282
 283 types_file_extension:
 284         CommandLineSwitches:--types-file-extension
 285         VimOptionMap:TypesFileExtension
 286         Type:string
 287         Default:taghl
 288         Help:Extension for types file (by default 'taghl', which with default prefix gives types_c.taghl for C files).
 289
 290 skip_patterns:
 291         CommandLineSwitches:--add-skip-pattern
 292         VimOptionMap:SkipPatterns
 293         Type:list
 294         Default:[]
 295         Help:List of (Python) regular expressions to match against keywords which should be excluded from the types file.
 296
 297 skip_reserved_keywords:
 298         CommandLineSwitches:--skip-reserved-keywords
 299         VimOptionMap:SkipReservedKeywords
 300         Type:bool
 301         Default:True
 302         Help:Don't highlight keywords that are reserved in a given language.
 303
 304 ctags_exe_full:
 305         CommandLineSwitches:--ctags-exe-full-path
 306         VimOptionMap:CtagsExeFull
 307         Type:string
 308         Default:ctags
 309         Help:CTAGS Executable Directory
 310
 311 ctags_arguments:
 312         CommandLineSwitches:--add-ctags-argument
 313         VimOptionMap:CtagsArguments
 314         Type:list
 315         Default:[]
 316         Help:Explicit list of arguments to pass to ctags (for use with non-recognised ctags implementations).
 317
 318 ctags_extra_arguments:
 319         CommandLineSwitches:--add-extra-ctags-argument
 320         VimOptionMap:CtagsExtraArguments
 321         Type:list
 322         Default:[]
 323         Help:List of extra arguments to pass to ctags.
 324
 325 ctags_variant:
 326         CommandLineSwitches:--ctags-variant
 327         VimOptionMap:CtagsVariant
 328         Type:string
 329         Default:exuberant
 330         Help:Tells TagHighlight which variant of ctags is being used: some have different requirements for their arguments.
 331
 332 include_docs:
 333         CommandLineSwitches:--include-docs
 334         Type:bool
 335         Default:False
 336         Help:Include docs or Documentation directory (stripped by default for speed)
 337
 338 check_keywords:
 339         CommandLineSwitches:--do-not-check-keywords
 340         Type:bool
 341         Default:True
 342         Help:Do not check validity of keywords (for speed)
 343
 344 include_matches:
 345         CommandLineSwitches:--include-invalid-keywords-as-matches
 346         VimOptionMap:IncludeSynMatches
 347         Type:bool
 348         Default:False
 349         Help:Include invalid keywords as regular expression matches (may slow it loading)
 350
 351 skip_vimkeywords:
 352         CommandLineSwitches:--exclude-vim-keywords
 353         VimOptionMap:SkipVimKeywords
 354         Type:bool
 355         Default:False
 356         Help:Don't include Vim keywords (they have to be matched with regular expression matches, which is slower)
 357
 358 parse_constants:
 359         CommandLineSwitches:--do-not-analyse-constants
 360         Type:bool
 361         Default:True
 362         Help:Do not treat constants as separate entries
 363
 364 languages:
 365         CommandLineSwitches:--include-language
 366         VimOptionMap:Languages
 367         Type:list
 368         Default:[]
 369         Help:Only include specified languages
 370
 371 types_file_location:
 372         CommandLineSwitches:--types-file-location
 373         VimOptionMap:TypesFileLocation
 374         Type:string
 375         Default:.
 376         Help:Specify the location for the generated types files
 377
 378 include_locals:
 379         CommandLineSwitches:--include-locals
 380         VimOptionMap:IncludeLocals
 381         Type:bool
 382         Default:False
 383         Help:Include local variables in the database
 384
 385 use_existing_tagfile:
 386         CommandLineSwitches:--use-existing-tagfile
 387         VimOptionMap:DoNotGenerateTags
 388         Type:bool
 389         Default:False
 390         Help:Do not generate tags: use an existing file
 391
 392 print_py_version:
 393         CommandLineSwitches:--pyversion
 394         Type:bool
 395         Default:False
 396         Help:Just print the version of python
 397
 398 print_config:
 399         CommandLineSwitches:--print-config
 400         Type:bool
 401         Default:False
 402         Help:Parse the various options and then print the configuration and exit (for debugging)
 403
 404 # vim: ff=unix:noet