NAME

nup - N-up multi-column paged output for commands and files

SYNOPSIS

nup [ options ] file ...
nup -e [ options ] command ...

  -h, --help             show help
      --version          show version
  -d, --debug            debug mode
  -n, --dryrun           dry-run mode
  -e, --exec             execute command mode
  -V, --parallel         parallel view mode
  -F, --fold             fold mode (disable page mode)
  -H, --filename         show filename headers (default: on)
  -G, --grid=#           grid layout (e.g., 2x3)
  -C, --pane=#           number of columns
  -R, --row=#            number of rows
  -P, --page=#           page height in lines
  -S, --pane-width=#     pane width (default: 85)
--bs, --border-style=#   border style (default: heavy-box)
--ls, --line-style=#     line style (none/truncate/wrap/wordwrap)
--cm, --colormap=#       color mapping (LABEL=COLOR)
      --white-board      black on white board
      --black-board      white on black board
      --green-board      white on green board
      --slate-board      white on dark slate board
      --pager=#          pager command (empty to disable)
      --no-pager         disable pager

VERSION

Version 0.9903

DESCRIPTION

nup is a simple wrapper script for optex -Mup. It provides a convenient way to view files or run commands with N-up output formatting using the App::optex::up module.

nup automatically detects the mode based on the first argument: if it is an existing file, file view mode is used; if it is an executable command, command mode is used. Use -e option to force command mode when needed.

OPTIONS

General Options

-h, --help

Show help message.

--version

Show version.

-d, --debug

Enable debug mode.

-n, --dryrun

Dry-run mode. Show the command without executing.

-e, --exec

Force command execution mode. Normally the mode is auto-detected, but use this option when you want to execute a file as a command.

-V, --parallel

Enable parallel view mode for ansicolumn. In this mode, each file is displayed in its own column without pagination, similar to --fold. Automatically enabled when multiple files are specified. Single file or stdin input results in single column output.

-F, --fold

Enable fold mode (disable page mode). In fold mode, the entire content is split evenly across columns without pagination. Page mode is the default.

-H, --filename

Show filename headers in file view mode. Enabled by default. Use --no-filename to disable.

Layout Options

-C N, --pane=N

Set the number of columns (panes).

-R N, --row=N

Set the number of rows.

-G CxR, --grid=CxR

Set grid layout. For example, -G2x3 creates 2 columns and 3 rows.

-P N, --page=N

Set the page height in lines.

-S N, --pane-width=N

Set the pane width in characters. Default is 85.

Style Options

--bs=STYLE, --border-style=STYLE

Set the border style. Default is heavy-box.

--ls=STYLE, --line-style=STYLE

Set the line style. Available: none, truncate, wrap, wordwrap.

--cm=SPEC, --colormap=SPEC

Set color mapping. Specify as LABEL=COLOR (e.g., --cm=BORDER=R). Available labels: TEXT, BORDER.

--white-board, --black-board, --green-board, --slate-board

Predefined color schemes for board-style display.

Pager Options

--pager=COMMAND

Set the pager command. Default is $PAGER or less. Use --pager= (empty) or --no-pager to disable pager.

--no-pager

Disable pager.

EXAMPLES

nup man nup                # view manual in multi-column
nup -C2 man perl           # 2 columns
nup -G2x2 man perl         # 2x2 grid (4-up)
nup -F man perl            # fold mode (no pagination)
nup file1.txt file2.txt    # view files side by side
nup -e ./script.sh         # force command mode for a file

INSTALLATION

Using cpanminus:

cpanm -n App::nup

DIAGNOSTICS

Both stdout and stderr of the command are merged and passed through the output filter. Error messages will appear in the paged output.

EXIT STATUS

The exit status of the executed command is not preserved because the output is passed through a filter pipeline.

SEE ALSO

App::optex::up, optex

AUTHOR

Kazumasa Utashiro

LICENSE

Copyright 2025 Kazumasa Utashiro.

This software is released under the MIT License. https://opensource.org/licenses/MIT