~ubuntu-branches/ubuntu/intrepid/edbrowse/intrepid

« back to all changes in this revision

Viewing changes to debian/edbrowse.1

  • Committer: Bazaar Package Importer
  • Author(s): Kapil Hari Paranjape
  • Date: 2007-05-09 07:33:04 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20070509073304-ywptg9g6iiitsg17
Tags: 3.2.1-1
* New upstream version (3.2.1). Closes: #421451.
  - can fetch and execute a local javascript file
    if required by local html file.
  - provide COPYING and CHANGES files.
* debian/rules:
  - add CHANGES to dh_installchangelogs line.
  - add dh_installman entry to install the man page.
* debian/copyright: updated to include the COPYING file.
* debian/edbrowse.1: added a basic man page.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Man page for edbrowse
 
2
.\"
 
3
.\" Copyright (C), 2007 Kapil Hari Paranjape
 
4
.\"
 
5
.\" You may distribute under the terms of the GNU General Public
 
6
.\" License as specified in the file /usr/share/common-licences/GPLv2
 
7
.\" that comes with the Debian distribution.
 
8
.\"
 
9
.\" Written by Kapil Hari Paranjape
 
10
.\" based on the edbdoc.html file written by Karl Dahlke.
 
11
.\" Last Modified on Wed,  9 May 2007 07:19:43 +0530
 
12
.\" Include a Macro From Branden Robinson's WTFM.PDF
 
13
.de URI
 
14
\\$2 \(la URI: \\$1 \(ra\\$3
 
15
..
 
16
.if \n[.g] .mso www.tmac
 
17
.\" End if Include
 
18
.TH edbrowse 1 2007-05-09 "edbrowse 3.2.1"
 
19
.SH NAME
 
20
edbrowse \- text editor and web browser
 
21
.SH SYNOPSIS
 
22
.BR edbrowse
 
23
.RI "[ " "file1" " ]"
 
24
.RI "[ " "file2" " ]"
 
25
.I ...
 
26
.LP
 
27
.BR edbrowse
 
28
.RI "[ " "url1" " ]"
 
29
.RI "[ " "url2" " ]"
 
30
.I " ..."
 
31
.LP
 
32
.SH DESCRIPTION
 
33
(This manual page was written for the Debian GNU/Linux distribution
 
34
because the original program does not have a man page. Instead the
 
35
program is documented in detail in the HTML documentation that
 
36
accompanies the program; see below.)
 
37
.PP
 
38
.BR edbrowse
 
39
is a line-oriented text editor very similar to
 
40
.BR ed (1),
 
41
It is used to create, display, modify and otherwise manipulate text
 
42
files.
 
43
.PP
 
44
In addition
 
45
.BR edbrowse
 
46
can be used to display web pages and edit the
 
47
contents of these pages. It supports the use of forms and Javascript in
 
48
web pages.
 
49
.PP
 
50
If
 
51
.BR edbrowse
 
52
is invoked with a
 
53
.I file
 
54
argument, then a copy of
 
55
.I file
 
56
is read into the editor's buffer. If it is invoked with a
 
57
.I url
 
58
argument, then the
 
59
.I url
 
60
is read into the editor's buffer and the HTML is rendered as text.
 
61
Changes are made to this copy and not directly to
 
62
.I file
 
63
or 
 
64
.I url
 
65
itself.
 
66
.PP
 
67
Please refer to
 
68
.BR ed (1)
 
69
for further details regarding the editing commands. Explanation of the
 
70
browsing functions can be found in the HTML documentation.
 
71
.PP
 
72
.SH EXAMPLES
 
73
To read the HTML documentation on a Debian system you can do
 
74
.IP
 
75
.BR "edbrowse file:///usr/share/doc/edbrowse/edbdoc.html"
 
76
.PP
 
77
To read (say) 20 lines of the buffer at a time starting from
 
78
the top use the command
 
79
.I `1z20'
 
80
followed by repeating
 
81
.I `z' 
 
82
to scroll another 20 lines at a time.
 
83
.PP
 
84
To quit the editor completely type
 
85
.I `qt'
 
86
\&. Upon quitting
 
87
.BR edbrowse ,
 
88
any changes not explicitly saved  with a
 
89
.I `w'
 
90
command are lost. The
 
91
.I `w'
 
92
command does not apply to URLs but one can save the corresponding
 
93
buffer to a file by the command \fIw file\fR.
 
94
.PP
 
95
.SH OPTIONS
 
96
.TP
 
97
.B \-h
 
98
Display the usage message.
 
99
.TP
 
100
.B \-e
 
101
Batch mode. This options causes 
 
102
.BR edbrowse
 
103
to exit when it encounters an error.
 
104
.TP
 
105
.B \-d?
 
106
Debug level. Can be set to a value between 0 and 9. The default is 1 
 
107
which prints the sizes of buffers. Some people like 2 which prints
 
108
out URLs as they are retrieved. This value can be changed within the 
 
109
editor with the
 
110
.I dbx
 
111
command with x a value betwen 0 and 9.
 
112
.TP
 
113
.B \-c
 
114
Edit config file. This command supresses the processing of the
 
115
configuration file
 
116
.I $HOME/.ebrc
 
117
and starts editing it instead. This option is useful if this file
 
118
is syntactically incorrect or otherwise corrupted.
 
119
.PP
 
120
.SH FILES
 
121
.TP 20
 
122
.I $HOME/.ebrc
 
123
Configuration file. The file which
 
124
.B edbrowse
 
125
reads when it starts up. If the file exists then it must be
 
126
syntactically correct.
 
127
.PP
 
128
.SH DIAGNOSTICS
 
129
When an error occurs,
 
130
if
 
131
.BR edbrowse 
 
132
it
 
133
prints a `?' and returns to command mode.
 
134
An explanation of the last error can be
 
135
printed with the
 
136
.I `h'
 
137
(help) command.
 
138
.PP
 
139
Attempting to quit
 
140
.B edbrowse
 
141
with the 
 
142
.I `q'
 
143
command or trying to edit another file before writing a modified buffer
 
144
results in an error. If the command is entered a second time, it succeeds,
 
145
but any changes to the buffer are lost.
 
146
.PP
 
147
.SH BUGS
 
148
This manual page is not complete.  Users should refer to the HTML
 
149
documentation for fuller details of the
 
150
configuration options and for details of the use of edbrowse.
 
151
.PP
 
152
.SH SEE ALSO
 
153
.IR ed (1),
 
154
.IR sed (1),
 
155
.IR pcrepattern (3).
 
156
.PP
 
157
The
 
158
.URL "/usr/share/doc/edbrowse/edbdoc.html" "HTML documentation" " "
 
159
provides greater detail about the program.
 
160
.PP
 
161
.SH AUTHORS
 
162
This manual page was originally written by Kapil Hari Paranjape
 
163
<kapil@imsc.res.in>,
 
164
for the Debian GNU/Linux system (but it may be used by others).
 
165
.PP
 
166
The
 
167
.B edbrowse
 
168
program is written by Karl Dahlke
 
169
<ehlhad@comcast.net>. The author maintains
 
170
.URL "http://www.eklhad.net/linux/app/" "a web page" " "
 
171
for the program.
 
172
.