Page

Allows you to redirect text into neovim. You can set it as $PAGER to view logs, diffs, various command outputs.

ANSI escape sequences will be interpreted by :term buffer, which makes page noticeably faster than vimpager and nvimpager. And text will be displayed instantly as it arrives - no need to wait until EOF.

Also, text from neovim :term buffer will be redirected directly into a new buffer in the same neovim instance - no nested neovim will be spawned. That's by utilizing $NVIM variable like neovim-remote does.

Bonus: another binary named nv is included, which reimplements neovim-remote but with interface similar to page. There's no intention to have all nvim --remote features — it should be only a simple file picker that prevents spawning nested neovim instance. Also, in contrast with neovim-remote there are some safeguards e.g. it won't open non-text files unless explicit flag is provided for that so nv * opens only text files in current directory. I recommend to read --help output and experiment with options a bit.

Ultimately, page and nv reuses all of neovim's text editing+navigating+searching facilities and will either facilitate all of plugins+mappings+options set in your neovim config.

Usage

• under regular terminal

• under neovim's terminal

CLI

Note: page and nv may be unergonomic to type so I suggest users to create alias like p and v

nvim/init.lua customizations

-- Opacity of popup window spawned with -+ option
vim.g.page_popup_winblend = 25

nvim/init.lua customizations (pager only)

Statusline appearance:

-- String that will append to buffer name
vim.g.page_icon_pipe = '|' -- When piped
vim.g.page_icon_redirect = '>' -- When exposes pty device
vim.g.page_icon_instance = '$' -- When `-i, -I` flags provided

Autocommand hooks:

-- Will run once when output buffer is created
vim.api.create_autocmd('User', {
    pattern = 'PageOpen',
    callback = lua_function,
})

-- Will run once when file buffer is created
vim.api.create_autocmd('User', {
    pattern = 'PageOpenFile',
    callback = lua_function,
})

Only with -C option provided:

-- will run always when output buffer is created
-- and also when `page` connects to instance `-i, -I` buffers:
vim.api.create_autocmd('User', {
    pattern = 'PageConnect',
    callback = lua_function,
})

-- Will run when page process exits
vim.api.create_autocmd('User', {
    pattern = 'PageDisconnect',
    callback = lua_function,
})

Shell hacks

To use as $PAGER without scrollback overflow:

export PAGER="page -q 90000"

# Alternatively

export PAGER="page -z 90000" # will pagerize output

# And you can combine both

export PAGER="page -q 90000 -z 90000"

To configure:

export PAGER="page -WfC -q 90000 -z 90000" # some sensible flags
alias page="$PAGER"

# Usage
ls | page -q 100 # you can specify the same flag multiple times:
                 # last provided will override previous

To use as $MANPAGER:

export MANPAGER="page -t man"

# Alternatively, to pick a bit better `man` highlighting:

man () {
    PROGRAM="${@[-1]}"
    SECTION="${@[-2]}"
    page -W "man://$PROGRAM${SECTION:+($SECTION)}"
}

To set nv as popup git commit message editor:

# Will spawn popup editor and exit on first write
git config --global core.editor "nv -K -+-R 80 -B"

To cd into directory passed to nv

nv() {
    #stdin_is_term #one_argument   #it's_dir
    if [ -t 1 ] && [ 1 -eq $# ] && [ -d $1 ]; then
        cd $1
    else
        nv $*
    fi
}

compdef _nv nv # if you have completions installed

To automatically lcd into terminal's directory:

chpwd () {
    [ ! -z "$NVIM" ] && nv -x "lcd $PWD"
}

To circumvent neovim config picking:

page -c NONE

# Alternatively, to override neovim config create this file:

touch $XDG_CONFIG_HOME/page/init.lua # init.vim is also supported

To set output buffer name as first two words from invoked command (zsh only):

preexec () {
    if [ -z "$NVIM" ]; then
        export PAGE_BUFFER_NAME="page"
    else
        WORDS=(${1// *|*})
        export PAGE_BUFFER_NAME="${WORDS[@]:0:2}"
    fi
}

Buffer defaults (pager)

Limitations (pager)

• Only ~100000 lines can be displayed (that's neovim terminal limit)
• No reflow: text that doesnt't fit into window will be lost on resize (due to data structures inherited from vim)

Installation

• From binaries

  • Grab binary for your platform from releases (currently Linux and OSX are supported)

• Arch Linux:

  • Package page-git is available on AUR
  • Or: git clone git@github.com:I60R/page.git && cd page && makepkg -ef && sudo pacman -U page-git*.pkg.tar.xz

• Homebrew:

  • Package page is available on Homebrew

• Manually:

  • Install rustup from your distribution package manager
  • Configure toolchain: rustup install stable && rustup default stable
  • git clone git@github.com:I60R/page.git && cd page && cargo install --path .