https://github.com/srirangav/pdfview
Terminal/CLI PDF viewer
https://github.com/srirangav/pdfview
cli macos macosx pdf pdf-document pdf-viewer terminal-based
Last synced: 6 months ago
JSON representation
Terminal/CLI PDF viewer
- Host: GitHub
- URL: https://github.com/srirangav/pdfview
- Owner: srirangav
- License: mit
- Created: 2022-03-19T06:57:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-07T08:24:46.000Z (over 2 years ago)
- Last Synced: 2025-03-26T19:36:54.814Z (7 months ago)
- Topics: cli, macos, macosx, pdf, pdf-document, pdf-viewer, terminal-based
- Language: Objective-C
- Homepage:
- Size: 338 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.txt
- License: LICENSE.txt
Awesome Lists containing this project
README
README
------
pdfview v.0.4.1
Homepage:
https://github.com/srirangav/pdfview
About:
pdfview is a command line program that displays any available
text in a PDF. On MacOSX, pdfview uses PDFKit (which is
available on MacOSX 10.4 or newer). On Linux/*bsd, pdfview
is a shell script that relies on pdftotext from either xpdf
or poppler:
https://www.xpdfreader.com/pdftotext-man.html
https://github.com/freedesktop/poppler
On Linux/*bsd, pdfview will wrap text using fmt(1) (first
choice) or fold(1), if they are available.
Usage:
Generally:
pdfview [files]
On MacOSX:
pdfview [options] [files]
If -q is specified, no error or information messages are
printed.
If -n is specified, the filename and page number are
printed for each line.
if -d is specified, the text is dehyphenated
if -r is specified, no text replacements are performed
(except dehyphenation, if requested) and the raw text
is displayed
If -e [expression] is specified, only lines matching the
specified expression are printed.
If -i is specified, then expression matching will be
performed on a case insensitive basis. If an expression
is not specified, this option is ignored.
If -c is specified, then, instead of printing matching
lines, the total number of matches for the specified
expression is printed. If an expression is not specified,
this option is ignored.
If -l is specified, as soon as the first match, searching
stops and the filename containing the match is printed.
If an expression is not specified, this option is ignored.
If -L is specified, the filename is printed only if it
does not contain a match is printed. If an expression is
not specified, this option is ignored.
If -p [pages] is specified, then only the text on the
specified pages numbers, if present in the first file,
provided to pdfview will be printed. If this option is
specified, only the first file provided to pdfview is
processed. All other files are ignored. The pages may
be specified as a comma separated list and can include
page ranges. The specified pages are sorted and printed
in sorted order, rather than in the specified order.
If -t is specified, then, instead of printing matching
lines, the total number of matches for the specified
expression on each page is printed. If an expression is
not specified, this option is ignored.
If -T is specified, then, instead of printing matching
lines, the total number of matches for the specified
expression on each page with more than one match is
printed. If an expression is not specified, this option
is ignored.
If -m is specified, then the available metadata (instead
of the content) of each file is printed.
Build (MacOSX only):
$ ./configure
$ make
Install:
On MacOSX:
$ ./configure
$ make
$ make install
By default, pdfview is installed in /usr/local/bin. To
install it in a different location, the alternate
installation prefix can be supplied to configure:
$ ./configure --prefix=""
or, alternately to make:
$ make install PREFIX=""
For example, the following will install pdfview in
/opt/local:
$ make PREFIX=/opt/local install
A DESTDIR can also be specified for staging purposes
(with or without an alternate prefix):
$ make DESTDIR="" [PREFIX=""] install
On Linux/*bsd:
Put pdfview.sh somewhere in your $PATH, for example:
$ cp pdfview.sh $HOME/bin/pdfview
$ chmod u+x $HOME/bin/pdfview
History:
v.0.4.1 Add support for printing metadata
v.0.4.0 Add support for printing specific pages
v.0.3.6 Add support for Monterey (MacOSX 12)
v.0.3.5 In the MacOSX version, add additional default
formatting
v.0.3.4 In the MacOSX version, add -d option to dehyphenate
text and -r option to print the raw text without any
text replacements
v.0.3.3 Add -P option to the MacOSX version to print counts
only on pages with matches and -L option to print
filenames only when there are no matches in the file
v.0.3.2 Add -l option to the MacOSX version so that pdfview
will stop searching as soon as the first match is
found
v.0.3.1 Add support for getting counts of matches to the
MacOSX version
v.0.3.0 Add support for regex matching to the MacOSX version
v.0.2.1 Add page numbering support to MacOSX version
v.0.2.0 Add PDFKit based implementation for MacOSX
v.0.1.3 Fixes based on shellcheck
v.0.1.2 Minor change for Debian
v.0.1.1 Update README.txt to mention MacOSX, FreeBSD,
and OpenBSD
v.0.1.0 Initial release
Platforms:
pdfview has been tested on MacOSX (11.x, 12.x). It may work
on earlier versions (MacOSX 10.4 and newer).
pdfview.sh has been tested on FreeBSD (13.0), OpenBSD (7.0),
and Debian (11.x). It should work on other systems that
have pdftotext installed.
Notes:
On MacOSX, regex matching requires MacOSX 10.7 or newer.
References:
https://stackoverflow.com/questions/3570591
https://unix.stackexchange.com/questions/25173
License:
See LICENSE.txt