/** Every less option key the pager options object accepts. */ export declare const LESS_OPTION_VALUES: { readonly 'search-skip-screen': "flag"; readonly 'SEARCH-SKIP-SCREEN': "flag"; readonly buffers: "value"; readonly 'auto-buffers': "flag"; readonly 'clear-screen': "flag"; readonly 'CLEAR-SCREEN': "flag"; readonly dumb: "flag"; readonly color: "value"; readonly 'quit-at-eof': "flag"; readonly 'QUIT-AT-EOF': "flag"; readonly force: "flag"; readonly 'quit-if-one-screen': "flag"; readonly 'hilite-search': "flag"; readonly 'HILITE-SEARCH': "flag"; readonly 'max-back-scroll': "value"; readonly 'ignore-case': "flag"; readonly 'IGNORE-CASE': "flag"; readonly 'jump-target': "value"; readonly 'status-column': "flag"; readonly 'lesskey-file': "value"; readonly 'lesskey-content': "value"; readonly 'lesskey-src': "value"; readonly 'quit-on-intr': "flag"; readonly 'no-lessopen': "flag"; readonly 'long-prompt': "flag"; readonly 'LONG-PROMPT': "flag"; readonly 'line-numbers': "flag"; readonly 'LINE-NUMBERS': "flag"; readonly 'log-file': "value"; readonly 'LOG-FILE': "value"; readonly pattern: "value"; readonly prompt: "value"; readonly quiet: "flag"; readonly QUIET: "flag"; readonly silent: "flag"; readonly SILENT: "flag"; readonly 'raw-control-chars': "flag"; readonly 'RAW-CONTROL-CHARS': "flag"; readonly 'squeeze-blank-lines': "flag"; readonly 'chop-long-lines': "flag"; readonly tag: "value"; readonly 'tag-file': "value"; readonly 'underline-special': "flag"; readonly 'UNDERLINE-SPECIAL': "flag"; readonly version: "flag"; readonly 'hilite-target': "flag"; readonly 'hilite-unread': "flag"; readonly 'HILITE-UNREAD': "flag"; readonly tabs: "value"; readonly 'no-init': "flag"; readonly 'max-forw-scroll': "value"; readonly window: "value"; readonly quotes: "value"; readonly tilde: "flag"; readonly help: "flag"; readonly 'lesskey-help': "flag"; readonly 'view-lesskey': "flag"; readonly shift: "value"; readonly 'no-keypad': "flag"; readonly 'old-bot': "flag"; readonly 'follow-name': "flag"; readonly 'use-backslash': "flag"; readonly rscroll: "value"; readonly 'no-histdups': "flag"; readonly mouse: "flag"; readonly MOUSE: "flag"; readonly emouse: "value"; readonly rmouse: "flag"; readonly 'wheel-lines': "value"; readonly 'save-marks': "flag"; readonly 'line-num-width': "value"; readonly 'status-col-width': "value"; readonly incsearch: "flag"; readonly 'use-color': "flag"; readonly 'use-js-regexp': "flag"; readonly 'file-size': "flag"; readonly 'status-line': "flag"; readonly header: "value"; readonly 'no-paste': "flag"; readonly 'form-feed': "flag"; readonly 'past-eof': "flag"; readonly 'no-edit-warn': "flag"; readonly 'no-warn-edit': "flag"; readonly 'no-shell': "flag"; readonly 'no-number-headers': "flag"; readonly 'no-search-headers': "flag"; readonly 'no-search-header-lines': "flag"; readonly 'no-search-header-columns': "flag"; readonly 'redraw-on-quit': "flag"; readonly 'search-options': "value"; readonly 'exit-follow-on-close': "flag"; readonly 'no-vbell': "flag"; readonly modelines: "value"; readonly intr: "value"; readonly wordwrap: "flag"; readonly 'show-preproc-errors': "flag"; readonly 'proc-backspace': "flag"; readonly 'PROC-BACKSPACE': "flag"; readonly 'proc-tab': "flag"; readonly 'PROC-TAB': "flag"; readonly 'proc-return': "flag"; readonly 'PROC-RETURN': "flag"; readonly cmd: "value"; readonly 'match-shift': "value"; readonly autosave: "value"; readonly 'end-prompt': "value"; }; /** * less option keys, typed: flags take a boolean, the rest a value. * Spelled out rather than mapped over LESS_OPTION_VALUES so each key * carries its own doc comment — the editor shows the description and * the default as you pick the name out of the completion list. * * A flag left out keeps less's startup state, which for nearly every * option means off; the exceptions are less's own inverted names (-B * --auto-buffers, -G --HILITE-SEARCH) and --no-shell, which a library * call starts ON. Only value options carry an @default, since a * triple's table state does not map onto one key's boolean. */ export interface LessOptions { /** Search skips current screen. */ 'search-skip-screen'?: boolean; /** Search starts just after target line. */ 'SEARCH-SKIP-SCREEN'?: boolean; /** Number of buffers. @default 64 */ buffers?: number | string; /** Don't automatically allocate buffers for pipes. */ 'auto-buffers'?: boolean; /** Repaint by clearing rather than scrolling. */ 'clear-screen'?: boolean; /** Repaint by clearing rather than scrolling. */ 'CLEAR-SCREEN'?: boolean; /** Dumb terminal. */ dumb?: boolean; /** Set screen colors. */ color?: number | string; /** Quit at end of file. */ 'quit-at-eof'?: boolean; /** Quit at end of file. */ 'QUIT-AT-EOF'?: boolean; /** Force open non-regular files. */ force?: boolean; /** Quit if entire file fits on first screen. */ 'quit-if-one-screen'?: boolean; /** Highlight only last match for searches. */ 'hilite-search'?: boolean; /** Don't highlight any matches for searches. */ 'HILITE-SEARCH'?: boolean; /** Backward scroll limit. @default -1 */ 'max-back-scroll'?: number | string; /** Ignore case in searches that do not contain uppercase. */ 'ignore-case'?: boolean; /** Ignore case in all searches. */ 'IGNORE-CASE'?: boolean; /** Screen position of target lines. @default '0' */ 'jump-target'?: number | string; /** Display a status column at left edge of screen. */ 'status-column'?: boolean; /** Use a compiled lesskey file. */ 'lesskey-file'?: number | string; /** A less option. */ 'lesskey-content'?: number | string; /** Use a lesskey source file. */ 'lesskey-src'?: number | string; /** Exit less in response to ctrl-C. */ 'quit-on-intr'?: boolean; /** Ignore the LESSOPEN environment variable. */ 'no-lessopen'?: boolean; /** Set prompt style. */ 'long-prompt'?: boolean; /** Set prompt style. */ 'LONG-PROMPT'?: boolean; /** Suppress line numbers in prompts and messages. */ 'line-numbers'?: boolean; /** Display line number at start of each line. */ 'LINE-NUMBERS'?: boolean; /** Copy to log file (standard input only). */ 'log-file'?: number | string; /** Copy to log file (unconditionally overwrite). */ 'LOG-FILE'?: number | string; /** Start at pattern (from command line). */ pattern?: number | string; /** Define new prompt. */ prompt?: number | string; /** Quiet the terminal bell. */ quiet?: boolean; /** Quiet the terminal bell. */ QUIET?: boolean; /** Quiet the terminal bell. */ silent?: boolean; /** Quiet the terminal bell. */ SILENT?: boolean; /** Output "raw" control characters. */ 'raw-control-chars'?: boolean; /** Output "raw" control characters. */ 'RAW-CONTROL-CHARS'?: boolean; /** Squeeze multiple blank lines. */ 'squeeze-blank-lines'?: boolean; /** Chop (truncate) long lines rather than wrapping. */ 'chop-long-lines'?: boolean; /** Find a tag. */ tag?: number | string; /** Use an alternate tags file. @default 'tags' */ 'tag-file'?: number | string; /** Change handling of backspaces, tabs and carriage returns. */ 'underline-special'?: boolean; /** Change handling of backspaces, tabs and carriage returns. */ 'UNDERLINE-SPECIAL'?: boolean; /** Display the version number of "less-pager-mini". */ version?: boolean; /** Highlight the target line. */ 'hilite-target'?: boolean; /** Highlight first new line after full screen movement. */ 'hilite-unread'?: boolean; /** Highlight first new line after any movement. */ 'HILITE-UNREAD'?: boolean; /** Set tab stops. */ tabs?: number | string; /** Don't use termcap init/deinit strings. */ 'no-init'?: boolean; /** Forward scroll limit. @default -1 */ 'max-forw-scroll'?: number | string; /** Set size of window. @default -1 */ window?: number | string; /** Set shell quote characters. @default '"' */ quotes?: number | string; /** Don't display tildes after end of file. */ tilde?: boolean; /** Display help (from command line). */ help?: boolean; /** Display lesskey help. */ 'lesskey-help'?: boolean; /** A less option. */ 'view-lesskey'?: boolean; /** Set horizontal scroll amount (0 = one half screen width). @default '0' */ shift?: number | string; /** Don't send termcap keypad init/deinit strings. */ 'no-keypad'?: boolean; /** Use old bottom of screen behavior. */ 'old-bot'?: boolean; /** The F command changes files if the input file is renamed. */ 'follow-name'?: boolean; /** Subsequent options use backslash as escape char. */ 'use-backslash'?: boolean; /** Set the character used to mark truncated lines. @default '>' */ rscroll?: number | string; /** Remove duplicates from command history. */ 'no-histdups'?: boolean; /** Enable mouse clicking and vertical scrolling. */ mouse?: boolean; /** Enable mouse clicking and vertical scrolling. */ MOUSE?: boolean; /** Enable mouse features. @default '-' */ emouse?: number | string; /** Reverse mouse scroll direction. */ rmouse?: boolean; /** Each click of the mouse wheel moves N lines. @default 1 */ 'wheel-lines'?: number | string; /** Retain marks across invocations of less. */ 'save-marks'?: boolean; /** Set the width of the -N line number field to N characters. @default 7 */ 'line-num-width'?: number | string; /** Set the width of the -J status column to N characters. @default 2 */ 'status-col-width'?: number | string; /** Search file as each pattern character is typed in. */ incsearch?: boolean; /** Enables colored text. */ 'use-color'?: boolean; /** Search with JavaScript's RegExp. */ 'use-js-regexp'?: boolean; /** Automatically determine the size of the input file. */ 'file-size'?: boolean; /** Highlight or color the entire line containing a mark. */ 'status-line'?: boolean; /** Use L lines (starting at line N) and C columns as headers. @default '-' */ header?: number | string; /** Ignore pasted input. */ 'no-paste'?: boolean; /** Stop scrolling when a form feed character is reached. */ 'form-feed'?: boolean; /** Scrolling commands continue past end of file. */ 'past-eof'?: boolean; /** Don't warn when using v command on a file opened via LESSOPEN. */ 'no-edit-warn'?: boolean; /** Don't warn when editing a file opened via LESSOPEN. */ 'no-warn-edit'?: boolean; /** Disable shell, pipe and editor commands. */ 'no-shell'?: boolean; /** Don't give line numbers to header lines. */ 'no-number-headers'?: boolean; /** Searches do not include header lines or columns. */ 'no-search-headers'?: boolean; /** Searches do not include header lines. */ 'no-search-header-lines'?: boolean; /** Searches do not include header columns. */ 'no-search-header-columns'?: boolean; /** Redraw final screen when quitting. */ 'redraw-on-quit'?: boolean; /** Set default options for every search. @default '-' */ 'search-options'?: number | string; /** Exit F command on a pipe when writer closes pipe. */ 'exit-follow-on-close'?: boolean; /** Disable the terminal's visual bell. */ 'no-vbell'?: boolean; /** Read N lines from the input file and look for vim modelines. @default 0 */ modelines?: number | string; /** Use C instead of ^X to interrupt a read. @default '' */ intr?: number | string; /** Wrap lines at spaces. */ wordwrap?: boolean; /** Display a message if preprocessor exits with an error status. */ 'show-preproc-errors'?: boolean; /** Process backspaces for bold/underline. */ 'proc-backspace'?: boolean; /** Treat backspaces as control characters. */ 'PROC-BACKSPACE'?: boolean; /** Expand tabs to spaces. */ 'proc-tab'?: boolean; /** Treat tabs as control characters. */ 'PROC-TAB'?: boolean; /** Delete carriage returns before newline. */ 'proc-return'?: boolean; /** Treat carriage returns as control characters. */ 'PROC-RETURN'?: boolean; /** A less option. */ cmd?: number | string; /** Show at least N characters to the left of a search match. @default '0' */ 'match-shift'?: number | string; /** Actions which cause the history file to be saved. @default '-' */ autosave?: number | string; /** String to be printed after erasing the prompt. @default '-' */ 'end-prompt'?: number | string; } /** * Every option LETTER the scan accepts, so `-R` and `-N` are offered * beside the long names. A letter carries no doc comment: less's help * describes the option, and the letter is one spelling of it. */ export type LessOptionLetter = '"' | '#' | '?' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'w' | 'x' | 'y' | 'z' | '~';