implement passthrough commandline options #238

Add the --passthrough, --force-passthrough and --no-passthrough
commandline options. Document them in --help and in the markdown docs.

Update scripts/pandoc-sh to account for the -S option no longer being
available in newer versions.

Update the markdown_src/ files from an earlier PR and regenerate the
markdown/ files.

Author: rkitover

Makefile

@@ -263,7 +263,7 @@ man/%.1: markdown_src/%.md
 	@if command -v pandoc >/dev/null; then \
 	    echo 'generating $@'; \
 	    ${MKPATH} `dirname '$@'` 2>/dev/null || true; \
-	    ${PANDOC} -Ss -f markdown_github $< -o $@; \
+	    ${PANDOC} -s -f markdown_github $< -o $@; \
 	else \
 	    if [ ! -r docs-warn-stamp ]; then \
 		echo >&2; \
@@ -283,7 +283,7 @@ html/%.html: %.md.work
 	@if command -v pandoc >/dev/null; then \
 	    echo 'generating $@'; \
 	    ${MKPATH} `dirname '$@'` 2>/dev/null || true; \
-	    ${PANDOC} -Ss --toc -f markdown_github $< -o $@; \
+	    ${PANDOC} -s --toc -f markdown_github $< -o $@; \
 	    rm -f $<; \
 	else \
 	    if [ ! -r docs-warn-stamp ]; then \

markdown/vimpager.md

@@ -20,6 +20,9 @@
   - [--cmd cmd](#--cmd-cmd)
   - [-u vimrc](#-u-vimrc)
   - [-s](#-s)
+  - [--passthrough](#--passthrough)
+  - [--force-passthrough](#--force-passthrough)
+  - [--no-passthrough](#--no-passthrough)
   - [-x](#-x)
 - [ANSI ESCAPE SEQUENCES AND OVERSTRIKES](#ansi-escape-sequences-and-overstrikes)
 - [PASSTHROUGH MODE](#passthrough-mode)
@@ -67,9 +70,9 @@ cd vimpager
 sudo make install-deb
 ```
 
-To just build the `.deb` use `make build-deb` instead.
+To just build the '.deb' use `make build-deb` instead.
 
-Otherwise use `make install`:
+Otherwise use 'make install':
 
 ```bash
 git clone git://github.com/rkitover/vimpager
@@ -86,8 +89,8 @@ The following make settings are supported at `make install` time:
 | prefix       | prefix for writing files, e.g. for GNU stow         |
 | POSIX_SHELL  | POSIX shell to use to run the scripts               |
 
-Note, you should `make clean` before modifying these make settings, as the `install` make target does not account for
-their change (when e.g. "configuring" vimpager; vimpager.configured).
+**NOTE:** you should `make clean` before modifying these make settings, as the
+'install' make target does not account for their change.
 
 If you got vimpager from the vim.org scripts section, just put it
 somewhere in your PATH, e.g.:
@@ -372,6 +375,21 @@ Use alternate .vimrc or .vimpagerrc.
 Squeeze blank lines into a single blank line. GNU man passes this option to
 /usr/bin/pager.
 
+## --passthrough
+
+If files fit on the screen, print them with syntax highlighting using vimcat
+instead of invoking the pager.
+
+## --force-passthrough
+
+Always print files with syntax highlighting to the terminal instead of invoking
+the pager, regardless of whether they fit on the screen.
+
+## --no-passthrough
+
+Never print files with syntax highlighting to the terminal with vimcat, always
+invoke the pager.
+
 ## -x
 
 Enable debugging output for the shell script part of vimpager.

markdown_src/vimpager.md

@@ -37,7 +37,9 @@ cd vimpager
 sudo make install-deb
 ```
 
-Otherwise use 'make install' instead:
+To just build the '.deb' use `make build-deb` instead.
+
+Otherwise use 'make install':
 
 ```bash
 git clone git://github.com/rkitover/vimpager
@@ -54,6 +56,9 @@ The following make settings are supported at `make install` time:
 | prefix       | prefix for writing files, e.g. for GNU stow         |
 | POSIX_SHELL  | POSIX shell to use to run the scripts               |
 
+**NOTE:** you should `make clean` before modifying these make settings, as the
+'install' make target does not account for their change.
+
 If you got vimpager from the vim.org scripts section, just put it
 somewhere in your PATH, e.g.:
 
@@ -337,6 +342,21 @@ Use alternate .vimrc or .vimpagerrc.
 Squeeze blank lines into a single blank line. GNU man passes this option to
 /usr/bin/pager.
 
+## --passthrough
+
+If files fit on the screen, print them with syntax highlighting using vimcat
+instead of invoking the pager.
+
+## --force-passthrough
+
+Always print files with syntax highlighting to the terminal instead of invoking
+the pager, regardless of whether they fit on the screen.
+
+## --no-passthrough
+
+Never print files with syntax highlighting to the terminal with vimcat, always
+invoke the pager.
+
 ## -x
 
 Enable debugging output for the shell script part of vimpager.

scripts/pandoc-sh

@@ -31,14 +31,29 @@ if ! ( pandoc --help | grep markdown_github >/dev/null ); then
     old_pandoc=1
 fi
 
+use_smart=
+# newer pandoc does not support -S
+if ! (pandoc --help | grep -- -S); then
+    use_smart=1
+fi
+
+
 first_arg=1
 for arg in "$@"; do
     [ $first_arg -eq 1 ] && set -- && first_arg=0
 
-    if [ "$arg" = markdown_github ]; then
+    if [ "$arg" = "-f" ]; then
+        if [ -z "$use_smart" ]; then
+            set -- "$@" -S -f
+        else
+            set -- "$@" -f
+        fi
+    elif [ "$arg" = markdown_github ]; then
 	if [ $old_pandoc -eq 1 ]; then
 	    set -- "$@" markdown
-	else
+        elif [ -n "$use_smart" ]; then
+	    set -- "$@" markdown_github+pandoc_title_block+smart
+        else
 	    set -- "$@" markdown_github+pandoc_title_block
 	fi
     else

vimpager

@@ -57,11 +57,7 @@ main() {
     fi
 
     # Parse the command line options as early as possible.  These variables might be set because of command line options and are thus initialized.
-    vim_options=
-    vimrc=
-    extra_c=
-    extra_cmd=
-    line_numbers=0
+    vim_options= vimrc= extra_c= extra_cmd= line_numbers=0 no_pass_thru=
 
     # Check for certain parameters to pass on to vim (or conceivably do something else)
     # Couldn't use getopt or getopts as neither supports options prepended with +
@@ -102,6 +98,19 @@ main() {
                 shift
                 squeeze_blank_lines=1
                 ;;
+            --passthrough)
+                shift
+                no_pass_thru=0
+                ;;
+            --force-passthrough)
+                shift
+                no_pass_thru=0
+                cat_files=1
+                ;;
+            --no-passthrough)
+                shift
+                no_pass_thru=1
+                ;;
             --)
                 shift
                 break
@@ -466,7 +475,9 @@ read_vim_settings() {
                         [ "${var#VAL:}" -eq 0 ] && disable_x11=1
                         ;;
                     3)
-                        [ "${var#VAL:}" -eq 0 ] && no_pass_thru=1
+                        if [ -z "$no_pass_thru" ]; then
+                            [ "${var#VAL:}" -eq 0 ] && no_pass_thru=1
+                        fi
                         ;;
                     4)
                         [ "${var#VAL:}" -ne 0 ] && ansiesc_available=1
@@ -628,6 +639,9 @@ With no FILE, or when FILE is -, read standard
   +G, +                              Go to the end of the file.
   -N, --LINE-NUMBERS                 Show line numbers.
   -s                                 Squeeze multiple blank lines into one.
+  ---passthrough                     If files fit on screen, print them with highlighting (DEFAULT.)
+  ---force-passthrough               Always print the files with highlighting, don't invoke pager.
+  ---no-passthrough                  Never print the files, always invoke pager.
   --cmd COMMAND                      Run (n)vim COMMAND before initialization.
   -c COMMAND                         Run (n)vim COMMAND after initialization.
   -u FILE                            Use FILE as the vimrc.