]> git.lizzy.rs Git - plan9front.git/blob - sys/man/1/mothra
a37be94469eb0fa90da2b2e763939cc3646e4a9f
[plan9front.git] / sys / man / 1 / mothra
1 .TH MOTHRA 1
2 .SH NAME
3 mothra \- retrieve and display World-Wide Web files
4 .SH SYNOPSIS
5 .B mothra
6 [
7 .B -dv
8 ]
9 [
10 .B -m
11 .I mtpt
12 ] [
13 .I url
14 ]
15 .SH DESCRIPTION
16 .I Mothra
17 uses
18 .IR webfs (4)
19 to retrieve and display files from the World-Wide Web,
20 by name or through hypertext links.
21 Web names, called URLs, have a peculiar syntax:
22 .IP
23 .EX
24 http://netlib.att.com/netlib/1127/www/1127.html
25 http://akebono.stanford.edu:80/yahoo/
26 http://www.teleport.com/~crowell/
27 .EE
28 .PP
29 The part up to the first colon gives the protocol for
30 retrieving the file.
31 .BR http: ,
32 Hyper-Text Transfer
33 Protocol, is the usual way of accessing web files.
34 .PD
35 .PP
36 .B //
37 begins the Internet address of the server where the file resides.
38 The address may contain a colon and a TCP port
39 number, which overrides the 
40 default port number for the service.  Next comes a
41 file name.  Finally, the file name may be followed by
42 .B #
43 and a string giving a label within the file where the
44 display should begin.
45 .PP
46 .I Mothra
47 starts with the
48 .I url
49 given on the command line, defaulting to
50 the environment variable
51 .BR $url .
52 .PP
53 There are a number of options:
54 .TP
55 .B  -d
56 Debug mode. Causes debug messages to appear in
57 .B $home/lib/mothra/mothra.err.
58 .TP
59 .B -m
60 Specify the
61 .IR webfs (4)
62 mountpoint with
63 .BR -m
64 .I mtpt.
65 The default is
66 .B /mnt/web.
67 .TP
68 .B -v
69 Verbose mode. Causes HTML errors to appear in
70 .B $home/lib/mothra/mothra.err.
71 .PP
72 The display contains the last message from
73 .I mothra,
74 a box where typed commands appear,
75 a scrollable list of previously visited files,
76 the title and URL of the current file,
77 and the scrollable text of the current file.
78 .PP
79 Button 1 selects and displays a file, either from the list
80 of previously visited pages or from a link (indicated
81 by underlined text or a boxed image) in the
82 current file.  Button 2 shows the URL of a file,
83 but does not retrieve or display it.
84 Button 3 pops up a menu of commands:
85 .TF alt\ display
86 .TP
87 .B alt display
88 Collapse or expand the navigation boxes at the top of the browser window.
89 .TP
90 .B moth mode
91 Enter moth mode and switch to the moth cursor. If the HREF of an image
92 link is different from the URL of the image itself, a link to the HREF will be
93 printed on the right side of the image. Clicking an image or link with mouse
94 button 1 prompts the user to save a copy of the file in the current directory.
95 Clicking mouse button 2 sets the target as the current URL.
96 Clicking the
97 .B moth mode
98 menu option again exits moth mode.
99 .TP
100 .B snarf url
101 Copy the current URL to the snarf buffer.
102 .TP
103 .B paste
104 Paste the current snarf buffer at the current cursor position.
105 .TP
106 .B save hit
107 Save the current URL to the hit list.
108 .TP
109 .B hit list
110 Retrieve and display the hit list.
111 .TP
112 .B exit
113 Ask for confirmation and quit.
114 .PD
115 .PP
116 The typed commands are:
117 .TF typed\ commands
118 .TP
119 .B a
120 Toggle alt display.
121 .TP
122 .BI g " url
123 Go to the page with the given URL.
124 .TP
125 .BI j " n
126 Jump to page
127 .I n
128 from the list of previously viewed pages.
129 .TP
130 .BI k
131 Kill images on the current page.
132 .TP
133 .BI m
134 Enter or exit moth mode.
135 .TP
136 .B r
137 Reload the current page.
138 .TP
139 .BI s " file
140 Save the current page in the given
141 .I file.
142 .TP
143 .BI W " file
144 Capture a screenshot of the entire browser window in the given
145 .I file.
146 .TP
147 .BI w " file
148 Capture a screenshot of the content area in the given
149 .I file.
150 .TP
151 .B q
152 Quit.
153 .PD
154 .PP
155 When
156 .I mothra
157 retrieves a direct link to a file that is not an
158 HTML document (for example a GIF or JPEG
159 image), it will start up an appropriate viewer, for example
160 .B page
161 (see
162 .IR page (1))
163 for most image files.
164 .SH FILES
165 .B $home/lib/mothra/hit.html 
166 the hit list
167 .br
168 .B $home/lib/mothra/mothra.err
169 log of debug and/or error messages, including HTML syntax errors
170 .SH SOURCE
171 .B /sys/src/cmd/mothra
172 .SH "SEE ALSO"
173 .IR webfs (4)
174 .SH BUGS
175 Files are saved in the form received,
176 not in the form suggested by the name in an
177 .B s
178 command. A directory index saved from moth mode may be written in
179 the local directory as a file named
180 .B index.
181 Sanitizing remote file names for the local file system is imperfect.
182 .PP
183 .I Mothra
184 is distributed in a preliminary state; it has more than its share of bugs. Note that
185 .I mothra,
186 like the other Guardian Monsters, has no particular concern for humanity.