1
2URLSCAN(1)                  General Commands Manual                 URLSCAN(1)
3
4
5

NAME

7       urlscan - browse the URLs in an email message from a terminal
8

SYNOPSIS

10       urlscan [options] < message
11
12       urlscan [options] message
13
14

DESCRIPTION

16       urlscan accepts a single email message on standard input, then displays
17       a terminal-based list of the URLs in the given  message.   Selecting  a
18       URL  uses  the  Python  webbrowser module to determine which browser to
19       open. The BROWSER environment variable will be used if it is set.
20
21       urlscan is primarily intended to be used with the mutt (1)  mailreader,
22       but it should work well with any terminal-based mail program.
23
24       urlscan is similar to urlview(1), but has the following additional fea‐
25       tures:
26
27       1. Support for more message encodings,  such  as  quoted-printable  and
28       base64.
29
30       2.  Extraction  and display of the context surrounding each URL. Toggle
31       context view on/off with `c`.
32
33       3. URLs are shortened by default to fit on one line. Toggle one or  all
34       shortened URLs with `s` or `S`.
35
36

OPTIONS

38       -c, --compact
39              Display  a simple list of the extracted URLs, instead of showing
40              the context of each URL. Also toggle with `c`  from  within  the
41              viewer.
42
43       -d, --dedupe
44              Remove duplicated URLs from the list of URLs.
45
46       -n, --no-browser
47              Disables the selection interface and print the links to standard
48              output.  Useful for scripting (implies --compact).
49
50

MUTT INTEGRATION

52       To integrate urlscan with mutt, include the following two  commands  in
53       ~/.muttrc:
54
55
56       macro index,pager \cb "<pipe-message> urlscan<Enter>" "call urlscan to
57       extract URLs out of a message"
58
59       macro attach,compose \cb "<pipe-entry> urlscan<Enter>" "call urlscan to
60       extract URLs out of a message"
61
62
63       Once these lines are in your mutt configuration file, pressing Control-
64       b will allow you to browse and open the URLs in the currently  selected
65       message.
66
67       Alternately,  you  can pipe a message into urlscan using the '|' opera‐
68       tor. This can be useful for applying a different flag (such as the '-d'
69       or '-c' options).
70
71

SEE ALSO

73       /usr/share/doc/urlscan/README, urlview(1), mutt(1)
74
75

AUTHOR

77       This  manual  page  was written by Daniel Burrows <dburrows@debian.org>
78       and Scott Hansen <firecat4153@gmail.com>
79
80
81
82                               February 26, 2017                    URLSCAN(1)