forked from firecat53/urlscan
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathurlscan.1
77 lines (57 loc) · 2.28 KB
/
urlscan.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
.\" Hey, EMACS: -*- nroff -*-
.TH URLSCAN 1 "February 26, 2017"
.SH NAME
urlscan \- browse the URLs in an email message from a terminal
.SH SYNOPSIS
\fBurlscan\fR [options] <
.I message
\fBurlscan\fR [options]
.I message
.SH DESCRIPTION
\fBurlscan\fR accepts a single email message on standard
input, then displays a terminal-based list of the URLs in the given
message. Selecting a URL uses the Python webbrowser module to
determine which browser to open. The \fBBROWSER\fR environment
variable will be used if it is set.
\fBurlscan\fR is primarily intended to be used with the
.B mutt
(1) mailreader, but it should work well with any terminal-based mail
program.
\fBurlscan\fR is similar to \fBurlview\fR(1), but has the following
additional features:
\fB1.\fR Support for more message encodings, such as quoted-printable
and base64.
\fB2.\fR Extraction and display of the context surrounding each URL. Toggle
context view on/off with `c`.
\fB3.\fR URLs are shortened by default to fit on one line. Toggle one or all
shortened URLs with `s` or `S`.
.SH OPTIONS
.TP
.B \-c, \-\-compact
Display a simple list of the extracted URLs, instead of showing the
context of each URL. Also toggle with `c` from within the viewer.
.TP
.B \-d, \-\-dedupe
Remove duplicated URLs from the list of URLs.
.TP
.B \-n, \-\-no-browser
Disables the selection interface and print the links to standard output.
Useful for scripting (implies \fB\-\-compact\fR).
.SH MUTT INTEGRATION
To integrate urlscan with mutt, include the following two commands in
\fB~/.muttrc\fR:
.ad l
macro index,pager \\cb "<pipe-message> urlscan<Enter>" "call urlscan to extract URLs out of a message"
macro attach,compose \\cb "<pipe-entry> urlscan<Enter>" "call urlscan to extract URLs out of a message"
.ad b
Once these lines are in your mutt configuration file, pressing
Control-b will allow you to browse and open the URLs in the currently
selected message.
Alternately, you can pipe a message into urlscan using the '|' operator. This
can be useful for applying a different flag (such as the '-d' or '-c' options).
.SH SEE ALSO
\fI/usr/share/doc/urlscan/README\fR,
\fBurlview\fR(1),
\fBmutt\fR(1)
.SH AUTHOR
This manual page was written by Daniel Burrows <[email protected]> and Scott Hansen <[email protected]>