|
2 | 2 |
|
3 | 3 | This is a standalone document previewer based on macOS's built-in |
4 | 4 | Quick Look engine——imagine a nicer `qlmanage`. It's particularly |
5 | | -useful as a quick command-line viewer for terminal applications, like |
6 | | -[mutt](http://www.mutt.org). |
| 5 | +useful for using from the command line or inside terminal |
| 6 | +applications, like [mutt](http://www.mutt.org). |
7 | 7 |
|
8 | 8 |  |
9 | 9 |
|
10 | 10 | ## Installation |
11 | 11 |
|
12 | 12 | You can either download a [pre-built |
13 | 13 | release](https://github.com/rsmmr/qlview/releases), or build it |
14 | | -yourself. Either way, you then probably want to copy the executable |
15 | | -into your `PATH`. |
| 14 | +yourself. |
16 | 15 |
|
17 | | -When getting the current release, you'll find the executable inside |
18 | | -the ZIP file you downloaded. While it's codesigned and notarized, |
19 | | -please note that you still cannot just double-click to run it, as it |
20 | | -is not an app but a command line application. |
| 16 | +When getting the current release, install it like any other |
| 17 | +application: open the disk image and drag the app to your |
| 18 | +`Applications` folder. |
21 | 19 |
|
22 | 20 | When building it yourself, make sure you have Xcode installed. Either |
23 | 21 | use that to open and build the project, or just run `make` from the |
24 | | -command line. You will then find the executable in |
25 | | -`build/Release/qlview`. |
| 22 | +command line. You will then find the application in |
| 23 | +`build/Release/qlview.app`. |
26 | 24 |
|
27 | 25 | ## Usage |
28 | 26 |
|
29 | | -Run it from the command line: |
| 27 | +You can start `qlview` from the Finder, and it'll open an empty window |
| 28 | +where you can drag a document into. More usefully, you can open |
| 29 | +documents from the command line through a custom URL scheme: |
30 | 30 |
|
31 | 31 | ``` |
32 | | -# qlview <file> |
| 32 | +# open qlview:/path/to/file |
33 | 33 | ``` |
34 | 34 |
|
35 | | -If you execute `qlview` without any arguments, it'll open an empty |
36 | | -window where you can drag a document into. |
37 | | - |
38 | 35 | ## Mutt integration |
39 | 36 |
|
40 | 37 | To use `qlview` with [mutt](http://www.mutt.org), there's a helper |
41 | 38 | script |
42 | 39 | [mutt-qlview](https://github.com/rsmmr/qlview/blob/main/mutt/mutt-qlview) |
43 | | -coming with the distribution. Put both that script and `qlview` itself |
44 | | -into your `PATH` and then add [these mailcap |
| 40 | +coming with the distribution. Put that script into your `PATH` and |
| 41 | +then add [these mailcap |
45 | 42 | entries](https://github.com/rsmmr/qlview/blob/main/mutt/mailcap) to |
46 | | -your mutt configuration; see [mutt's |
| 43 | +your mutt configuration. See [mutt's |
47 | 44 | manual](http://www.mutt.org/doc/manual/#mailcap) for more on that. |
48 | 45 |
|
49 | 46 | You can also add the following to your `.muttrc` to quickly open the |
|
0 commit comments