commit bfd29c14af1f765b1c028d2ae10835a185fc5bf5 from: Omar Polo date: Wed Dec 01 09:48:18 2021 UTC update manpages commit - 04146b9f1a7131fb515e5502114b8f9b9696206b commit + bfd29c14af1f765b1c028d2ae10835a185fc5bf5 blob - cae9a4902742c1ab99e6774238fee59a77e451ac blob + 278b226f426dc5f532d60c76a7d767e1eda082a6 --- site/telescope.1.html +++ site/telescope.1.html @@ -19,22 +19,25 @@ TELESCOPE(1) @@ -57,7 +60,7 @@ - @@ -77,12 +80,19 @@
config
Specify an alternative configuration file. By default - $HOME/.telescope/config is loaded.
+ $HOME/.config/telescope/config is loaded.
, --help
Display version and usage.
Configtest mode. Only check the configuration file for validity.
+
, + --safe
+
“Safe” (or “sandbox”) mode. Prevent + telescope from writing files to the disk and to + acquire the lock, allowing to run multiple instances at the same time. + telescope still loads the session file and the + custom about pages.
, --version
Display version.
@@ -174,6 +184,202 @@ file:// URL,
  • otherwise assume it's a Gemini URL.
  • + +
    +

    +

    During the startup, telescope reads the + configuration file at ~/.config/telescope/config or + ~/.telescope/config.

    +

    It's possible to load a custom configuration file using the + -c flag.

    +

    telescope will also load a file called + config-TERM, where “TERM” is the name + of the terminal type (i.e. the TERM environment variable), if it exists.

    +

    The format of the configuration file is fairly flexible. The + current line can be extended over multiple ones using a backslash + (‘\’). Comments can be put anywhere in the file using a hash + mark (‘#’), and extend to the end of the current line, but + backslashes can't be used to extend comments over multiple lines.

    +

    The following constructs are available:

    +
    +
    + map key + cmd
    +
    Bind key to the function cmd + in the keymap map. Valid values for map are + “global-map” (i.e. when the user is viewing a page) and + “minibuffer-map” (i.e. when the minibuffer has the focus.) + key follows the same syntax described in + DEFAULT KEY BINDINGS and + all the possible functions are listed in + INTERACTIVE COMMANDS.
    +
    + proto via + url
    +
    Use url as proxy for all URLs with protocol + proto. url must be a Gemini + URI without path, query and fragment component.
    +
    + opt = + val
    +
    Set the option opt to the value + val. Valid options are: +

    +
    +
    autosave
    +
    (integer) If greater than zero, save the session after the specified + amount of seconds after some events happens (new or closed tabs, + visited a link ...) Defaults to 20.
    +
    dont-wrap-pre
    +
    (integer) If nonzero, don't wrap preformatted blocks. Defaults to + 0.
    +
    download-path
    +
    (string) The default download path. Defaults to + /tmp.
    +
    emojify-link
    +
    (integer) If nonzero, when the text of a link starts with an emoji + followed by a space, use that emoji as line prefix. Defaults to + 1.
    +
    enable-colors
    +
    (integer) If nonzero, enable colours. Defaults to 0 if + NO_COLORS is set, 1 otherwise.
    +
    fill-column
    +
    (integer) If greater than zero, lines of text will be formatted in a + way that don't exceed the given number of columns. Defaults to + 80.
    +
    hide-pre-blocks
    +
    (integer) If nonzero, hide by default the body of the preformatted + blocks. Defaults to zero. push-button can be + used to toggle the visibility per-block.
    +
    hide-pre-closing-line
    +
    (integer) If nonzero, hide the closing line of preformatted blocks. + Defaults to 0.
    +
    hide-pre-context
    +
    (integer) If nonzero, hide the start and end line of the preformatted + blocks. If both hide-pre-context and hide-pre-blocks are nonzero, + preformatted blocks are irremediably hidden. Defaults to zero.
    +
    new-tab-url
    +
    (string) URL for the new tab page. Defaults to + “about:new”.
    +
    olivetti-mode
    +
    (integer) If nonzero, enable olivetti-mode + Defaults to 1.
    +
    set-title
    +
    (integer) If nonzero, set the terminal title to the page title. + Defaults to 1.
    +
    tab-bar-show
    +
    (integer) If tab-bar-show is -1 hide the tab bar permanently, if 0 + show it unconditionally. If it's 1, show the bar only when there is + more than one tab. Defaults to 1.
    +
    +
    +
    + name option
    +
    Change the styling of the element identified by + name. Multiple options may be specified within curly + braces. Valid style identifiers are: +
    +
    +
    line
    +
    the area outside the lines in the body of the page.
    +
    line.compl
    +
    the completions.
    +
    line.compl.current
    +
    the current completion.
    +
    line.help
    +
    text in the *Help* buffer.
    +
    line.download.ongoing
    +
    an ongoing download
    +
    line.download.done
    +
    a completed download
    +
    line.download.info
    +
    informational text in the *Downloads* buffer.
    +
    line.text
    +
    text lines.
    +
    line.link
    +
    link lines.
    +
    line.title1..3
    +
    headings
    +
    line.item
    +
    item lines.
    +
    line.quote
    +
    quotes.
    +
    line.pre.start
    +
    the heading of a preformatted block.
    +
    line.pre
    +
    the content of a preformatted block.
    +
    line.pre.end
    +
    the closing line of a preformatted block.
    +
    download
    +
    the download pane
    +
    minibuffer
    +
    the minibuffer.
    +
    modeline
    +
    the modeline.
    +
    tabline
    +
    the tabline.
    +
    tabline.tab
    +
    the non-focused tabs.
    +
    tabline.current
    +
    the focused tab.
    +
    +
    +

    Valid options are:

    +
    +
    + prefix [line + [trail]]
    +
    Sets the text attributes. If only one value is given, + line and trail default to + that; if two values are given then trail + defaults to prefix. Each attribute is a + comma-separated list of keywords: +
    +
    +
    +
    no attributes.
    +
    +
    best highlighting mode for the terminal.
    +
    +
    underlines the text.
    +
    +
    reverses background/foreground colors.
    + +
    makes the text blinking.
    +
    +
    half bright.
    +
    +
    extra bright or bold.
    +
    +
    +

    Only the style identifiers with the “line.” + prefix accept up to three attributes. The other will only use the + first one given.

    +
    +
    + prefix [line + [trail]]
    +
    Sets the background color. Follows the same behaviour as + attr regarding the optional parameters. The + colour is one of black, red, green, yellow, blue, magenta, cyan and + white; colour0 to colour255 (or color0 to color255) from the + 256-colour set; default for the default colour.
    +
    + prefix [line + [trail]]
    +
    Sets the foreground color. It behaves just like + bg.
    +
    + prfx [cont]
    +
    Sets the prefix for the current line type to + prfx and cont as the + prefix for the continuation lines (i.e. when a long line gets + wrapped.) If cont is not given its value will be + the same of prfx.
    +
    +
    +

    -

    During the startup, telescope reads the - configuration file at ~/.telescope/config or the one - given with the -c flag.

    -

    telescope will also load a file called - config-TERM, where “TERM” is the name - of the terminal type (i.e. the TERM environment variable), if it exists.

    -

    The format of the configuration file is fairly flexible. The - current line can be extended over multiple ones using a backslash - (‘\’). Comments can be put anywhere in the file using a hash - mark (‘#’), and extend to the end of the current line, but - backslashes can't be used to extend comments over multiple lines.

    -

    The following constructs are available:

    -
    -
    - map key - cmd
    -
    Bind key to the function cmd - in the keymap map. Valid values for map are - “global-map” (i.e. when the user is viewing a page) and - “minibuffer-map” (i.e. when the minibuffer has the focus.) - key follows the same syntax described in - DEFAULT KEY BINDINGS and - all the possible functions are listed in - INTERACTIVE COMMANDS.
    -
    - proto via - url
    -
    Use url as proxy for all URLs with protocol - proto. url must be a Gemini - URI without path, query and fragment component.
    -
    - opt = - val
    -
    Set the option opt to the value - val. Valid options are: -

    -
    -
    autosave
    -
    (integer) If greater than zero, save the session after the specified - amount of seconds after some events happens (new or closed tabs, - visited a link ...) Defaults to 20.
    -
    dont-wrap-pre
    -
    (integer) If nonzero, don't wrap preformatted blocks. Defaults to - 0.
    -
    emojify-link
    -
    (integer) If nonzero, when the text of a link starts with an emoji - followed by a space, use that emoji as line prefix. Defaults to - 1.
    -
    enable-colors
    -
    (integer) If nonzero, enable colours. Defaults to 0 if - NO_COLORS is set, 1 otherwise.
    -
    fill-column
    -
    (integer) If greater than zero, lines of text will be formatted in a - way that don't exceed the given number of columns. Defaults to - 80.
    -
    hide-pre-blocks
    -
    (integer) If nonzero, hide by default the body of the preformatted - blocks. Defaults to zero. push-button can be - used to toggle the visibility per-block.
    -
    hide-pre-closing-line
    -
    (integer) If nonzero, hide the closing line of preformatted blocks. - Defaults to 0.
    -
    hide-pre-context
    -
    (integer) If nonzero, hide the start and end line of the preformatted - blocks. If both hide-pre-context and hide-pre-blocks are nonzero, - preformatted blocks are irremediably hidden. Defaults to zero.
    -
    new-tab-url
    -
    (string) URL for the new tab page. Defaults to - “about:new”.
    -
    olivetti-mode
    -
    (integer) If nonzero, enable olivetti-mode - Defaults to 1.
    -
    set-title
    -
    (integer) If nonzero, set the terminal title to the page title. - Defaults to 1.
    -
    tab-bar-show
    -
    (integer) If tab-bar-show is -1 hide the tab bar permanently, if 0 - show it unconditionally. If it's 1, show the bar only when there is - more than one tab. Defaults to 1.
    -
    -
    -
    - name option
    -
    Change the styling of the element identified by - name. Multiple options may be specified within curly - braces. Valid style identifiers are: -
    -
    -
    line
    -
    the area outside the lines in the body of the page.
    -
    line.compl
    -
    the completions.
    -
    line.compl.current
    -
    the current completion.
    -
    line.help
    -
    text in the *Help* buffer.
    -
    line.text
    -
    text lines.
    -
    line.link
    -
    link lines.
    -
    line.title1..3
    -
    headings
    -
    line.item
    -
    item lines.
    -
    line.quote
    -
    quotes.
    -
    line.pre.start
    -
    the heading of a preformatted block.
    -
    line.pre
    -
    the content of a preformatted block.
    -
    line.pre.end
    -
    the closing line of a preformatted block.
    -
    minibuffer
    -
    the minibuffer.
    -
    modeline
    -
    the modeline.
    -
    tabline
    -
    the tabline.
    -
    tabline.tab
    -
    the non-focused tabs.
    -
    tabline.current
    -
    the focused tab.
    -
    -
    -

    Valid options are:

    -
    -
    - prefix [line - [trail]]
    -
    Sets the text attributes. If only one value is given, - line and trail default to - that; if two values are given then trail - defaults to prefix. Each attribute is a - comma-separated list of keywords: -
    -
    -
    -
    no attributes.
    -
    -
    best highlighting mode for the terminal.
    -
    -
    underlines the text.
    -
    -
    reverses background/foreground colors.
    - -
    makes the text blinking.
    -
    -
    half bright.
    -
    -
    extra bright or bold.
    -
    -
    -

    Only the style identifiers with the “line.” - prefix accept up to three attributes. The other will only use the - first one given.

    -
    -
    - prefix [line - [trail]]
    -
    Sets the background color. Follows the same behaviour as - attr regarding the optional parameters. The - colour is one of black, red, green, yellow, blue, magenta, cyan and - white; colour0 to colour255 (or color0 to color255) from the - 256-colour set; default for the default colour.
    -
    - prefix [line - [trail]]
    -
    Sets the foreground color. It behaves just like - bg.
    -
    - prfx [cont]
    -
    Sets the prefix for the current line type to - prfx and cont as the - prefix for the continuation lines (i.e. when a long line gets - wrapped.) If cont is not given its value will be - the same of prfx.
    -
    -
    -
    -
    -

    When telescope is started, it inspects the following environment variables:

    @@ -867,25 +890,37 @@ doesn't matter.
    The user's terminal name.
    +
    , + XDG_CONFIG_HOME, + XDG_DATA_HOME
    +
    If defined can alter the default location of the files used.

    +

    By default telescope follows the XDG Base + Directory Specification. However, if ~/.telescope + exists, XDG is ignored and all the files are stored inside it. The usage of + XDG_CACHE_HOME, + XDG_CONFIG_HOME and + XDG_DATA_HOME can further alter the location of + these files.

    +

    -
    ~/.telescope/bookmarks.gmi
    -
    Bookmarks file.
    -
    ~/.telescope/config
    +
    ~/.config/telescope/config
    Default configuration file.
    -
    ~/.telescope/known_hosts
    +
    ~/.local/share/telescope/pages/about_*.gmi
    +
    Overrides for built-in about: pages.
    +
    ~/.local/share/telescope/bookmarks.gmi
    +
    Bookmarks file.
    +
    ~/.local/share/telescope/known_hosts
    Hash of the certificates for all the known hosts. Each line contains three fields: hostname with optional port number, hash of the certificate and a numeric flag.
    -
    ~/.telescope/lock
    +
    ~/.cache/telescope/lock
    Lock file used to prevent multiple instance of telescope from running at the same time.
    -
    ~/.telescope/pages/about_*.gmi
    -
    Overrides for built-in about: pages.
    -
    ~/.telescope/session
    +
    ~/.cache/telescope/session
    The list of tabs from the last session. Every line identifies a tab and contains three space-separated fields: the full URL, a comma-separated list of attributes and the cached title. Is written by @@ -896,7 +931,7 @@

    It's possible to browse “the small web” (i.e. simple websites) by using programs like the duckling-proxy by defining a proxy in - ~/.telescope/config:

    + ~/.config/telescope/config:

    proxy http via "gemini://127.0.0.1:1965"
     proxy https via "gemini://127.0.0.1:1965"
    @@ -908,19 +943,32 @@ proxy https via "gemini://127.0.0.1:1965"

    +

    +

    XDG Base Directory + Specification, + https://specifications.freedesktop.org/basedir-spec/latest/.

    +
    +

    The telescope program was written by Omar Polo <op@omarpolo.com>.

    +

    +

    telescope assumes a UTF-8 environment and + doesn't do anything to cope with other encodings. This can cause weird + rendering issues if you're lucky, or possibly worst things depending on your + locale and terminal emulator.

    +
    +

    There's no UI for out-of-band certificates validation.

    telescope[-Chnv] + [-ChnSv] [-c config] [URL]
    - +
    August 27, 2021October 8, 2021 OpenBSD 7.0
    blob - 1457102e0e3ae6800cd2e8eae69da256ad757397 blob + f3092be2cea1f62137f001c125c2b77fa14cd0c5 --- site/telescope.1.txt +++ site/telescope.1.txt @@ -4,7 +4,7 @@ NAME telescope multi-protocol browser SYNOPSIS - telescope [-Chnv] [-c config] [URL] + telescope [-ChnSv] [-c config] [URL] DESCRIPTION telescope is an interactive browser that supports the Finger, Gemini and @@ -16,13 +16,19 @@ DESCRIPTION -C, --colors Show all available colors and exit. -c config Specify an alternative configuration file. By default - $HOME/.telescope/config is loaded. + $HOME/.config/telescope/config is loaded. -h, --help Display version and usage. -n Configtest mode. Only check the configuration file for validity. + -S, --safe Safe (or sandbox) mode. Prevent telescope from + writing files to the disk and to acquire the lock, + allowing to run multiple instances at the same time. + telescope still loads the session file and the custom + about pages. + -v, --version Display version. UI CONCEPTS @@ -102,6 +108,143 @@ SUPPORTED PROTOCOLS if it starts with ./ or / assume it's a file:// URL, otherwise assume it's a Gemini URL. +CONFIGURATION FILE + During the startup, telescope reads the configuration file at + ~/.config/telescope/config or ~/.telescope/config. + + It's possible to load a custom configuration file using the -c flag. + + telescope will also load a file called config-TERM, where TERM is the + name of the terminal type (i.e. the TERM environment variable), if it + exists. + + The format of the configuration file is fairly flexible. The current + line can be extended over multiple ones using a backslash (\). + Comments can be put anywhere in the file using a hash mark (#), and + extend to the end of the current line, but backslashes can't be used to + extend comments over multiple lines. + + The following constructs are available: + + bind map key cmd + Bind key to the function cmd in the keymap map. Valid values for + map are global-map (i.e. when the user is viewing a page) and + minibuffer-map (i.e. when the minibuffer has the focus.) key + follows the same syntax described in DEFAULT KEY BINDINGS and all + the possible functions are listed in INTERACTIVE COMMANDS. + + proxy proto via url + Use url as proxy for all URLs with protocol proto. url must be a + Gemini URI without path, query and fragment component. + + set opt = val + Set the option opt to the value val. Valid options are: + + autosave (integer) If greater than zero, save the session + after the specified amount of seconds after some + events happens (new or closed tabs, visited a link + ...) Defaults to 20. + dont-wrap-pre (integer) If nonzero, don't wrap preformatted + blocks. Defaults to 0. + download-path (string) The default download path. Defaults to + /tmp. + emojify-link (integer) If nonzero, when the text of a link + starts with an emoji followed by a space, use that + emoji as line prefix. Defaults to 1. + enable-colors (integer) If nonzero, enable colours. Defaults to + 0 if NO_COLORS is set, 1 otherwise. + fill-column (integer) If greater than zero, lines of text will + be formatted in a way that don't exceed the given + number of columns. Defaults to 80. + hide-pre-blocks + (integer) If nonzero, hide by default the body of + the preformatted blocks. Defaults to zero. + push-button can be used to toggle the visibility + per-block. + hide-pre-closing-line + (integer) If nonzero, hide the closing line of + preformatted blocks. Defaults to 0. + hide-pre-context + (integer) If nonzero, hide the start and end line + of the preformatted blocks. If both hide-pre- + context and hide-pre-blocks are nonzero, + preformatted blocks are irremediably hidden. + Defaults to zero. + new-tab-url (string) URL for the new tab page. Defaults to + about:new. + olivetti-mode (integer) If nonzero, enable olivetti-mode + Defaults to 1. + set-title (integer) If nonzero, set the terminal title to + the page title. Defaults to 1. + tab-bar-show (integer) If tab-bar-show is -1 hide the tab bar + permanently, if 0 show it unconditionally. If + it's 1, show the bar only when there is more than + one tab. Defaults to 1. + + style name option + Change the styling of the element identified by name. Multiple + options may be specified within curly braces. Valid style + identifiers are: + line the area outside the lines in the + body of the page. + line.compl the completions. + line.compl.current the current completion. + line.help text in the *Help* buffer. + line.download.ongoing an ongoing download + line.download.done a completed download + line.download.info informational text in the + *Downloads* buffer. + line.text text lines. + line.link link lines. + line.title1..3 headings + line.item item lines. + line.quote quotes. + line.pre.start the heading of a preformatted block. + line.pre the content of a preformatted block. + line.pre.end the closing line of a preformatted + block. + download the download pane + minibuffer the minibuffer. + modeline the modeline. + tabline the tabline. + tabline.tab the non-focused tabs. + tabline.current the focused tab. + + Valid options are: + + attr prefix [line [trail]] + Sets the text attributes. If only one value is given, + line and trail default to that; if two values are given + then trail defaults to prefix. Each attribute is a + comma-separated list of keywords: + normal no attributes. + standout best highlighting mode for the terminal. + underline underlines the text. + reverse reverses background/foreground colors. + blink makes the text blinking. + dim half bright. + bold extra bright or bold. + + Only the style identifiers with the line. prefix accept + up to three attributes. The other will only use the + first one given. + + bg prefix [line [trail]] + Sets the background color. Follows the same behaviour as + attr regarding the optional parameters. The colour is + one of black, red, green, yellow, blue, magenta, cyan and + white; colour0 to colour255 (or color0 to color255) from + the 256-colour set; default for the default colour. + + fg prefix [line [trail]] + Sets the foreground color. It behaves just like bg. + + prefix prfx [cont] + Sets the prefix for the current line type to prfx and + cont as the prefix for the continuation lines (i.e. when + a long line gets wrapped.) If cont is not given its value + will be the same of prfx. + DEFAULT KEY BINDINGS The default key bindings are very similar to GNU Emacs, but care has been taken to include also bindings familiar for vi(1) and CUA users. In @@ -350,135 +493,7 @@ INTERACTIVE COMMANDS tabnew tab-new tabp tab-previous q and wq kill-telescope - -CONFIGURATION FILE - During the startup, telescope reads the configuration file at - ~/.telescope/config or the one given with the -c flag. - telescope will also load a file called config-TERM, where TERM is the - name of the terminal type (i.e. the TERM environment variable), if it - exists. - - The format of the configuration file is fairly flexible. The current - line can be extended over multiple ones using a backslash (\). - Comments can be put anywhere in the file using a hash mark (#), and - extend to the end of the current line, but backslashes can't be used to - extend comments over multiple lines. - - The following constructs are available: - - bind map key cmd - Bind key to the function cmd in the keymap map. Valid values for - map are global-map (i.e. when the user is viewing a page) and - minibuffer-map (i.e. when the minibuffer has the focus.) key - follows the same syntax described in DEFAULT KEY BINDINGS and all - the possible functions are listed in INTERACTIVE COMMANDS. - - proxy proto via url - Use url as proxy for all URLs with protocol proto. url must be a - Gemini URI without path, query and fragment component. - - set opt = val - Set the option opt to the value val. Valid options are: - - autosave (integer) If greater than zero, save the session - after the specified amount of seconds after some - events happens (new or closed tabs, visited a link - ...) Defaults to 20. - dont-wrap-pre (integer) If nonzero, don't wrap preformatted - blocks. Defaults to 0. - emojify-link (integer) If nonzero, when the text of a link - starts with an emoji followed by a space, use that - emoji as line prefix. Defaults to 1. - enable-colors (integer) If nonzero, enable colours. Defaults to - 0 if NO_COLORS is set, 1 otherwise. - fill-column (integer) If greater than zero, lines of text will - be formatted in a way that don't exceed the given - number of columns. Defaults to 80. - hide-pre-blocks - (integer) If nonzero, hide by default the body of - the preformatted blocks. Defaults to zero. - push-button can be used to toggle the visibility - per-block. - hide-pre-closing-line - (integer) If nonzero, hide the closing line of - preformatted blocks. Defaults to 0. - hide-pre-context - (integer) If nonzero, hide the start and end line - of the preformatted blocks. If both hide-pre- - context and hide-pre-blocks are nonzero, - preformatted blocks are irremediably hidden. - Defaults to zero. - new-tab-url (string) URL for the new tab page. Defaults to - about:new. - olivetti-mode (integer) If nonzero, enable olivetti-mode - Defaults to 1. - set-title (integer) If nonzero, set the terminal title to - the page title. Defaults to 1. - tab-bar-show (integer) If tab-bar-show is -1 hide the tab bar - permanently, if 0 show it unconditionally. If - it's 1, show the bar only when there is more than - one tab. Defaults to 1. - - style name option - Change the styling of the element identified by name. Multiple - options may be specified within curly braces. Valid style - identifiers are: - line the area outside the lines in the body - of the page. - line.compl the completions. - line.compl.current the current completion. - line.help text in the *Help* buffer. - line.text text lines. - line.link link lines. - line.title1..3 headings - line.item item lines. - line.quote quotes. - line.pre.start the heading of a preformatted block. - line.pre the content of a preformatted block. - line.pre.end the closing line of a preformatted - block. - minibuffer the minibuffer. - modeline the modeline. - tabline the tabline. - tabline.tab the non-focused tabs. - tabline.current the focused tab. - - Valid options are: - - attr prefix [line [trail]] - Sets the text attributes. If only one value is given, - line and trail default to that; if two values are given - then trail defaults to prefix. Each attribute is a - comma-separated list of keywords: - normal no attributes. - standout best highlighting mode for the terminal. - underline underlines the text. - reverse reverses background/foreground colors. - blink makes the text blinking. - dim half bright. - bold extra bright or bold. - - Only the style identifiers with the line. prefix accept - up to three attributes. The other will only use the - first one given. - - bg prefix [line [trail]] - Sets the background color. Follows the same behaviour as - attr regarding the optional parameters. The colour is - one of black, red, green, yellow, blue, magenta, cyan and - white; colour0 to colour255 (or color0 to color255) from - the 256-colour set; default for the default colour. - - fg prefix [line [trail]] - Sets the foreground color. It behaves just like bg. - - prefix prfx [cont] - Sets the prefix for the current line type to prfx and - cont as the prefix for the continuation lines (i.e. when - a long line gets wrapped.) If cont is not given its value - will be the same of prfx. - ENVIRONMENT When telescope is started, it inspects the following environment variables: @@ -490,21 +505,29 @@ ENVIRONMENT TERM The user's terminal name. + XDG_CACHE_HOME, XDG_CONFIG_HOME, XDG_DATA_HOME + If defined can alter the default location of the files used. + FILES - ~/.telescope/bookmarks.gmi - Bookmarks file. - ~/.telescope/config + By default telescope follows the XDG Base Directory Specification. + However, if ~/.telescope exists, XDG is ignored and all the files are + stored inside it. The usage of XDG_CACHE_HOME, XDG_CONFIG_HOME and + XDG_DATA_HOME can further alter the location of these files. + + ~/.config/telescope/config Default configuration file. - ~/.telescope/known_hosts + ~/.local/share/telescope/pages/about_*.gmi + Overrides for built-in about: pages. + ~/.local/share/telescope/bookmarks.gmi + Bookmarks file. + ~/.local/share/telescope/known_hosts Hash of the certificates for all the known hosts. Each line contains three fields: hostname with optional port number, hash of the certificate and a numeric flag. - ~/.telescope/lock + ~/.cache/telescope/lock Lock file used to prevent multiple instance of telescope from running at the same time. - ~/.telescope/pages/about_*.gmi - Overrides for built-in about: pages. - ~/.telescope/session + ~/.cache/telescope/session The list of tabs from the last session. Every line identifies a tab and contains three space-separated fields: the full URL, a comma-separated list of attributes and the cached title. Is @@ -513,7 +536,7 @@ FILES EXAMPLES It's possible to browse the small web (i.e. simple websites) by using programs like the duckling-proxy by defining a proxy in - ~/.telescope/config: + ~/.config/telescope/config: proxy http via "gemini://127.0.0.1:1965" proxy https via "gemini://127.0.0.1:1965" @@ -522,10 +545,20 @@ EXAMPLES telescope -c /dev/null +STANDARDS + XDG Base Directory Specification, + https://specifications.freedesktop.org/basedir-spec/latest/. + AUTHORS The telescope program was written by Omar Polo . +CAVEATS + telescope assumes a UTF-8 environment and doesn't do anything to cope + with other encodings. This can cause weird rendering issues if you're + lucky, or possibly worst things depending on your locale and terminal + emulator. + BUGS There's no UI for out-of-band certificates validation. -OpenBSD 7.0 August 27, 2021 OpenBSD 7.0 +OpenBSD 7.0 October 8, 2021 OpenBSD 7.0