Library

struct Keystroke

Structure that defines a keystroke.

Fields

• raw::String: Raw keystroke code converted to string.
• value::String: String representing the keystroke.
• alt::Bool: true if ALT key was pressed (only valid if value != :char).
• ctrl::Bool: true if CTRL key was pressed (only valid if value != :char).
• shift::Bool: true if SHIFT key was pressed (only valid if value != :char).

_ascend(node::SyntaxNode) -> SyntaxNode

Ascend to the most specific SyntaxNode containing all the information needed for @help.

_collaterate(input::String, cursor_pos::Integer) -> Integer

Based on cursor position, collaterate (branch) to the intended token's index.

_descend(node::SyntaxNode, search_index::Integer) -> SyntaxNode

Descend to the most specific syntax node containing search_index.

_extract_identifier(input::AbstractString, cursor_pos::Integer) -> String

Extract identifier from the input line using the cursor position.

If the cursor is on an identifier (including module hierarchy like A.B.C) or on the character behind it, return that identifier. If the cursor is not on an identifier, but in the argument/parameter list of a valid callable, return the callable name.

Extraction works even for invalid (i.e. incomplete) input.

_help!(pargerd::Pager) -> Nothing

Open a new pager with the help.

_helpstring(x::SyntaxNode) -> String

Extract the string from syntax node x to be provided for @help.

_jlgetch(stream::IO) -> Keystroke

Wait for an keystroke in the stream stream and return it (see Keystroke).

_register_help_shortcuts(repl) -> Nothing

Register the <Alt> + h and <F1> shortcuts in the REPL to show help for the identifier under the cursor.

_show_pager_extended_help(s, _, _) -> Symbol

Show the pager extended help for the identifier under the cursor in the REPL.

_show_pager_help(s, extended) -> Symbol

Show either the regular or the extended pager help for the identifier under the cursor.

_show_pager_regular_help(s, _, _) -> Symbol

Show the pager help for the identifier under the cursor in the REPL.

_tryparsestmt(x::String) -> SyntaxNode

Try to parse x into a SyntaxNode. If there are errors or warnings, they are ignored.

debug_keycode() -> Nothing

Debug key codes.

delete_keybinding(key::Union{Char, Symbol}; kwargs...) -> Nothing

Delete the keybinding key. The modifiers keys can be selected using the keywords alt, ctrl, and shift.

For more information about how specify key see set_keybinding.

drop_all_preferences!()

Drop all preferences.

Examples

julia> TerminalPager.drop_all_preference!()

drop_preference!(pref::String, value) -> Nothing

Drop the preference pref.

Examples

julia> TerminalPager.drop_preference!("visual_mode_line_background")

pager(obj; kwargs...)

Call the pager to show the output of the object obj.

Keywords

• auto::Bool: If true, then the pager is only shown if the output does not fit into the display. (Default = false)
• change_freeze::Bool: If true, then the user can change the number of frozen rows and columns inside the pager. (Default = true)
• frozen_columns::Int = 0: Number of columns to be frozen at startup. (Default = 0)
• frozen_rows::Int = 0: Number of rows to be frozen at startup. (Default = 0)
• hashelp::Bool = true: If true, then the user can see the pager help. (Default = true)
• has_visual_mode::Bool = true: If true, the user can use the visual mode. (Default = true)
• show_ruler::Bool: If true, a vertical ruler is shown at the pager with the line numbers. (Default = false)
• use_alternate_screen_buffer::Bool: If true, the pager will use the alternate screen buffer, which keeps the current screen when exiting the pager. Notice, however, that we use the XTerm escape sequences here. Hence, if your terminal is different, this option can lead to rendering problems.

Preferences

The user can defined custom preferences using the function TerminalPager.set_preference!. The available preferences are listed as follows:

• "active_search_decoration": String with the ANSI escape sequence to decorate the active search element. One can easily obtain this sequence by converting a Crayon to string. (Default = string(crayon"black bg:yellow"))
• "inactive_search_decoration": String with the ANSI escape sequence to decorate the inactive search element. One can easily obtain this sequence by converting a Crayon to string. (Default = string(crayon"black bg:light_gray"))
• "always_use_alternate_screen_buffer_in_repl_mode": If true, we will always use the alternate screen buffer when showing the pager in REPL mode. (Default = false)
• "block_alternate_screen_buffer": If true, the alternate screen buffer support will be globally blocked, regardless of the keyword options. This modification is helpful when the terminal is not compatible with XTerm. (Default = false)
• "pager_mode": If it is "vi", some keywords are modified to match the behavior of Vi. Notice that this change only takes effect when a new Julia session is initialized. (Default = "default")
• "visual_mode_line_background": String with the ANSI code of the background for the selected lines in the visual mode. (Default = "100")
• "visual_mode_active_line_background": String with the ANSI code of the background for the active line in the visual mode. (Default = "44")

For more information, see: TerminalPager.set_preference!, TerminalPager.drop_preference!, and TerminalPager.drop_all_preferences!.

reset_keybindings() -> Nothing

Reset key bindings to the original ones.

set_keybinding(key::Union{Char, Symbol}, action::Symbol; kwargs...) -> Nothing

Set key binding key to the action action. The modifiers keys can be selected using the keywords alt, ctrl, and shift.

key can be a Char or a Symbol indicating one of the following special keys:

"<up>", "<down>", "<right>", "<left>", "<home>", "<end>", "<F1>", "<F2>",
"<F3>", "<F4>", "<F5>", "<F6>", "<F7>", "<F8>", "<F9>", "<F10>", "<F11>",
"<F12>", "<keypad_dot>", "<keypad_enter>", "<keypad_asterisk>",
"<keypad_plus>", "<keypad_minus>", "<keypad_slash>", "<keypad_equal>",
"<keypad_0>", "<keypad_1>", "<keypad_2>", "<keypad_3>", "<keypad_4>",
"<keypad_5>", "<keypad_6>", "<keypad_7>", "<keypad_8>", "<keypad_9>",
"<delete>", "<pageup>", "<pagedown>", "<tab>"

action can be one of the following symbols:

:quit, :help, :up, :down, :left, :right, :fastup, :fastdown, :fastleft,
:fastright :bol, :eol, :pageup, :pagedown, :home, :end

set_preference!(pref::String, value) -> Nothing

Set the preference pref to the value.

Examples

julia> TerminalPager.set_preference!("visual_mode_line_background", "44")

@help(f)

Open the documentation of the function, macro or other object f in pager.

Examples

julia> @help write

@stdout_to_pager(ex_in)

Capture the stdout generated by ex_in and show inside a pager.