webrowse: webrowse.man - 1.7.3 vs. 2.0.0 changes

"Fossies" - the Fresh Open Source Software Archive

Source code changes of the file "webrowse.man" between
webrowse-1.7.3.tgz and webrowse-2.0.0.tgz

About: webrowse is a tool for interfacing between a Mozilla web browser and the rest of a Unix/X11 environment, via the `-remote` option.

[ To the main webrowse source changes report ]

webrowse.man (webrowse-1.7.3.tgz)	:	webrowse.man (webrowse-2.0.0.tgz)
WEBROWSE(1) General Commands Manual WEBROWSE(1)		WEBROWSE(1) General Commands Manual WEBROWSE(1)

NAME		NAME
webrowse - browse the given input in a local web browser, with markup		webrowse - browse the given input in a local web browser, with markup

SYNOPSIS		SYNOPSIS

webrowse [ -N \| -M ] [ -s \| -x \| -mq \| -u \| -c ] [ -k minutes ] [ -p \| -a		webrowse [ -C \| -Z \| -N \| -M ] [ -O ] [ -s \| -x \| -mq \| -u \| -c ] [ -k mi
] [ -i id ] [ -w		nutes ] [ -p \| -a
\| -t ] [ -rnvo ] [ -h ] [ file ]		] [ -i id ] [ -w \| -t ] [ -rnvo ] [ -h ] [ file ]

DESCRIPTION		DESCRIPTION

Webrowse can be used for convenient file or URL loading remote contr		Webrowse can be used for convenient file or URL loading remote control of
ol of Netscape,		Chrome, Mozilla
Mozilla or Mosaic browsers, for textual reference HTML markup, and,		(eg Firefox), Netscape or Mosaic browsers (though the latter two are
for example, for		essentially obso-
interfacing a browser to news and mail readers as a hypertextual external		lete), for textual reference HTML markup, and, for example, for interfaci
viewer for mail		ng a browser to
messages or news articles containing HTML or containing text with em		news and mail readers as a hypertextual external viewer for mail messages
bedded URLs, mail		or news articles
addresses and other references. See the EXAMPLES section below.		containing HTML or containing text with embedded URLs, mail addresses a
		nd other refer-
		ences. See the EXAMPLES section below. Statements below about Mozilla g
		enerally apply to
		Netscape as well.

Simply given a file argument, webrowse will direct a browser already runn ing on the user's		Simply given a file argument, webrowse will direct a browser already runn ing on the user's

display to load the given file. With Netscape or Mozilla, the browser		display to load the given file. With Chrome and newer Mozilla, a ne
may be automati-		w browser will be
cally deiconified and raised as well. The browser must be running on the		started if one is not already running. With Mozilla, the browser may
same (network)		be automatically
filesystem. If the -m is supplied, webrowse will interpret the file a		deiconified and raised as well. The browser must be running on the same
s text and create		host/filesystem.
and load a temporary copy of the file containing HTML markup to hyperlink		If the -m option is supplied, webrowse will interpret the file as text an
the URLs, short-		d create and load
ened URLs, FTP locations, mail addresses, header newsgroups, news		a temporary copy of the file containing HTML markup to hyperlink the URLs
article IDs, and		, shortened URLs,
filesystem pathnames in the text to their references. A temporary file i		FTP locations, mail addresses, header newsgroups, news article IDs, and
s used to hold		filesystem path-
and load the standard input if no file argument is given. By default, th		names in the text to their references. A temporary file is used to
e temporary files		hold and load the
are deleted 10 minutes after they've been first loaded by the browser. T		standard input if no file argument is given. By default, the temporary f
his delay can be		iles are deleted
set or disabled with the -k option or WB_KEEP environment variable. If		10 minutes after they've been first loaded by the browser. This delay c
a -u or -c option		an be set or dis-
is supplied, webrowse will interpret the command line argument, or the st		abled with the -k option or WB_KEEP environment variable. If a -u or -c
andard input if		option is sup-
there isn't one, as a URL to browse or as a Netscape/Mozilla remote c		plied, webrowse will interpret the command line argument, or the standa
ontrol command to		rd input if there
run, respectively.		isn't one, as a URL to browse or as an (older) Mozilla remote control
		command to run,
		respectively.

OPTIONS		OPTIONS

-N Use a Netscape or Mozilla browser. This is the default unless		-C Use a Chrome browser. This is the default only if the WB_BR
the WB_BROWSER		OWSER environment
environment variable is set to mosaic. The WB_NETSCAPE environ		variable contains chrom. The WB_CHROME environment variable
ment variable can		can be set to
be set to select which browser command to use.		select which browser command to use.

-M Use a Mosaic browser. This is the default only if the WB_BRO		-Z or -N Use a Mozilla or Netscape browser. This is the default unle
WSER environment		ss the WB_BROWSER
variable is set to mosaic.		environment variable contains chrom or mosaic. The WB_MOZILLA
		or WB_NETSCAPE
		environment variable can be set to select which browser command
		to use.

		-M Use a Mosaic browser. This is the default only if the WB_BR
		OWSER environment
		variable contains mosaic.

		-O Use the old interface of Mozilla, eg applicable for Firefox
		versions before
		36.0. This is the default only if the WB_MOZOLD environment
		variable is non-
		empty.

-s Tag and treat the standard input as HTML instead of text.		-s Tag and treat the standard input as HTML instead of text.

-x Tag and treat the standard input as XML instead of text.		-x Tag and treat the standard input as XML instead of text.


-m Markup and load a text copy of the input (whether a file or th e standard input)		-m Markup and load a text copy of the input (whether a file or the standard input)
with heuristically identified hyperlinks to Web, FTP, mail, new s and file refer-		with heuristically identified hyperlinks to Web, FTP, mail, new s and file refer-
ences.		ences.


-q Markup and load a text copy of the input (whether a file or th		-q Markup and load a text copy of the input (whether a file or the
e standard input)		standard input)
with quoted mail/news message lines in italic or bold, alternat		with quoted mail/news message lines in italic or bold, altern
ing by depth of		ating by depth of
nesting.		nesting.


-u Take the command line argument, or the standard input if ther e isn't one, as a		-u Take the command line argument, or the standard input if there isn't one, as a
URL to browse, instead of as a file.		URL to browse, instead of as a file.


-c Take the command line argument, or the standard input if there		-c Take the command line argument, or the standard input if ther
isn't one, as a		e isn't one, as a
remote control command to run, instead of as a file. This wo		remote control command to run, instead of as a file. This work
rks with Netscape		s with the old
or Mozilla only.		interface of Mozilla only.

-k minutes		-k minutes
Keep (ie, don't delete) any temporary files for the given integ er number of min-		Keep (ie, don't delete) any temporary files for the given integ er number of min-

utes. If the minutes is the string forever, then the tempo		utes. If the minutes is the string forever, then the tempora
rary files aren't		ry files aren't
ever deleted by webrowse, under the assumption they will be cle		ever deleted by webrowse, under the assumption they will be cl
aned up later by		eaned up later by
some other means. Once temporary files are deleted, the br		some other means. Once temporary files are deleted, the brows
owser will not be		er will not be
able to reload or re-enter them. The default is the value of t		able to reload or re-enter them. The default is the value of
he WB_KEEP envi-		the WB_KEEP envi-
ronment variable, or 10 minutes if it isn't set.		ronment variable, or 10 minutes if it isn't set.


-p Use a sleeping background shell process to delete any kept		-p Use a sleeping background shell process to delete any kept
temporary files.		temporary files.
This will fail to complete should the process be killed while s		This will fail to complete should the process be killed while
leeping, and is		sleeping, and is
only recommended for short temporary file lifetimes. This meth od is the default		only recommended for short temporary file lifetimes. This meth od is the default
unless the WB_SLEEP environment variable is set to at.		unless the WB_SLEEP environment variable is set to at.

-a Use an at(1) job to delete any kept temporary files. This meth od is the default		-a Use an at(1) job to delete any kept temporary files. This meth od is the default
only if the WB_SLEEP environment variable is set to at.		only if the WB_SLEEP environment variable is set to at.


-i id The window ID (with Netscape/Mozilla) or process ID (with Mosai		-i id The window ID (with older Mozilla) or process ID (with Mosaic)
c) of an existing		of an existing
browser to use for loading. The default is any value of the W		browser to use for loading. The default is any value of the
B_ID environment		WB_ID environment
variable (see for more details).		variable (see for more details).


-w Open a new browser window, off of an already running browser		-w Open a new browser window, off of an already running browser,
, for loading the		for loading the
input. By default, any running browser window may be used.		input. This is the default with Chrome and newer Mozil
		la, and for other
		browsers, by default, any running browser window may be used.

-t Open a new browser tab, inside an already running browser wind ow, for loading		-t Open a new browser tab, inside an already running browser wind ow, for loading

the input. This works with newer versions of Netscape/Mozilla only.		the input. This doesn't work with Mosaic or very old versions of Mozilla.


-r Don't deiconify/raise the browser window. The default for Ne		-r Don't deiconify/raise the browser window. The default for ol
tscape/Mozilla is		der Mozilla is to
to raise the window, while Mosaic will never raise the window.		raise the window, while newer Mozilla will always riase the wi
		ndow and Chrome
		and Mosaic will never raise the window.


-n Don't actually use the browser at all. This is useful if only what is printed		-n Don't actually use the browser at all. This is useful if onl y what is printed
is of interest.		is of interest.


-v Prints the shell command to run for remote control of the bro		-v Prints the shell command to run for remote control of the brows
wser. This works		er. This doesn't
with Netscape/Mozilla only.		work with Mosaic.


-o Prints the input (whether a file or the standard input, or whet		-o Prints the input (whether a file or the standard input, or whe
her marked up or		ther marked up or
not), perhaps in addition to loading it into the browser. Th		not), perhaps in addition to loading it into the browser. This
is can be used to		can be used to
capture the marked up version of the input for other uses.		capture the marked up version of the input for other uses.

-h Prints a helpful usage message.		-h Prints a helpful usage message.

ENVIRONMENT VARIABLES		ENVIRONMENT VARIABLES
WB_BROWSER		WB_BROWSER

The default browser to use, Netscape/Mozilla by default, unless		The default browser to use, Mozilla by default, unless co
set to mosaic.		ntaining chrom or
This may be overridden by the -N or -M options.		mosaic. This may be overridden by the -C, -Z, -N or -M options
		.

		WB_CHROME The Chrome browser command name to use, chromium-browser by def
		ault.

		WB_MOZILLA or WB_NETSCAPE
		The Mozilla or Netscape browser command name to use, firefox by
		default.

		WB_MOZOLD If non-empty, the default is to use the older interface of Mozi
		lla or Netscape,
		eg applicable for Firefox versions before 36.0.

		WB_TMP The directory in which to create any temporary files for use
		with any browser.
		The default depends on the browser in use. This may be ov
		erridden by the
		WB_CHTMP, WB_MZTMP, WB_NSTMP or WB_MSTMP environment variables.


WB_NETSCAPE		WB_CHTMP The directory in which to create any temporary files for
The Netscape or Mozilla browser command name to use, net		use with Chrome,
scape by default.		$HOME/.cache/chromium, $HOME/tmp or /tmp (the first which exis
mozilla could be a common setting.		ts) by default.
		This overrides WB_TMP.
WB_TMP The directory in which to create any temporary files for
use with either
browser. The default depends on the browser in use. This may
be overridden by
the WB_NSTMP or WB_MSTMP environment variables.

WB_NSTMP The directory in which to create any temporary files for
use with Net-
scape/Mozilla, $HOME/.mozilla, $HOME/.netscape, $HOME/tmp o
r /tmp (the first
which exists) by default. This overrides WB_TMP.


WB_MSTMP The directory in which to create any temporary files for u		WB_MZTMP or WB_NSTMP
se with Mosaic,		The directory in which to create any temporary files for
		use with Mozilla,
		$HOME/.mozilla, $HOME/.netscape, $HOME/tmp or /tmp (the first w
		hich exists) by
		default. This overrides WB_TMP.

		WB_MSTMP The directory in which to create any temporary files for
		use with Mosaic,
$HOME/tmp or /tmp (the first which exists) by default. This ov errides WB_TMP.		$HOME/tmp or /tmp (the first which exists) by default. This ov errides WB_TMP.


WB_UMASK webrowse uses a umask of 077 when creating temporary files, unless overriden		WB_UMASK webrowse uses a umask of 077 when creating temporary files, unless overriden
with this.		with this.

WB_KEEP The number of minutes to wait before deleting any temporary fil es, or the string		WB_KEEP The number of minutes to wait before deleting any temporary fil es, or the string
forever if they're not ever to be deleted. 10 minutes is the d efault. This may		forever if they're not ever to be deleted. 10 minutes is the d efault. This may
be overridden by the -k option.		be overridden by the -k option.


WB_SLEEP The default method to use to delete kept temporary files, sl eep by default,		WB_SLEEP The default method to use to delete kept temporary files, sleep by default,
unless set to at. This may be overridden by the -p or -a optio ns.		unless set to at. This may be overridden by the -p or -a optio ns.


WB_ID With Netscape/Mozilla, this can be set to the window ID of an		WB_ID With older Mozilla, this can be set to the window ID of an exis
existing browser		ting browser win-
window to specify the use of that window for loading, instead o		dow to specify the use of that window for loading, instead of j
f just the first		ust the first one
one found on the display. For example, under X Window		found on the display. For example, under X Windows, xwininfo(1
s, xwininfo(1) or		) or xlswins(1)
xlswins(1) can identify window IDs. xwinid(1) is a suppleme		can identify window IDs. xwinid(1) is a supplementary scri
ntary script to		pt to webrowse to
webrowse to conveniently interface these programs, so one c		conveniently interface these programs, so one can simply use th
an simply use the		e output of, eg,
output of, eg, xwinid -i $WB_NETSCAPE to set this value. With		xwinid -i $WB_MOZILLA to set this value. With Mosaic, this
Mosaic, this can		can be set to the
be set to the process ID of a running browser to specify the us		process ID of a running browser to specify the use of that brow
e of that browser		ser for loading,
for loading, instead of the one associated with the process ID		instead of the one associated with the process ID list
listed in the		ed in the file
file $HOME/.mosaicpid. This variable may be overridden by the		$HOME/.mosaicpid. This variable may be overridden by the -i op
-i option.		tion. Chrome and
		newer Mozilla cannot make use of this.

		WB_RUNURL If present, a Bourne-shell command to run in the background jus
		t before webrows-
		ing a URL.


WB_PWD The command to run to determine the current working director y, instead of the		WB_PWD The command to run to determine the current working directory, instead of the
configured default command (usually pwd(1)).		configured default command (usually pwd(1)).

EXAMPLES		EXAMPLES

Besides its usage directly from the command line, webrowse can be useful		Besides its usage directly from the command line, webrowse can be useful
as a tool within		as a tool within
other scripts and, creatively, as an interface between a web browser a		other scripts and, creatively, as an interface between a web browser and
nd other applica-		other applica-
tions. Most usages fall into two categories. One, based on webrowse -s,		tions. Most usages fall into two categories. One, based on webrowse
is useful for		-s, is useful for
sending HTML that is found outside a web context into a browser so it ma		sending HTML that is found outside a web context into a browser so it may
y be viewed prop-		be viewed prop-
erly. The other, based on webrowse -m, is useful for sending text that		erly. The other, based on webrowse -m, is useful for sending text th
contains URLs,		at contains URLs,
mail addresses, filesystem pathnames, etc into a browser with these i		mail addresses, filesystem pathnames, etc into a browser with these it
tems conveniently		ems conveniently
hyperlinked.		hyperlinked.

The following vi(1) macros, for your .exrc file, may be used to view the currently editted		The following vi(1) macros, for your .exrc file, may be used to view the currently editted

text in a browser with markup (and perhaps in a new window), or to (re)l		text in a browser with markup (and perhaps in a new window), or to (re)lo
oad the currently		ad the currently
editted file into a browser from vi. The latter can facilitate HTML deve		editted file into a browser from vi. The latter can facilitate HTML de
lopment with vi		velopment with vi
using a browser for WYSIWYG-like viewing of the developing HTML source.		using a browser for WYSIWYG-like viewing of the developing HTML source.
(Control charac-		(Control charac-
ters are shown in carat-notation.)		ters are shown in carat-notation.)

map _wb :w !webrowse -m		map _wb :w !webrowse -m
map _wm :w !webrowse -mw^M^M		map _wm :w !webrowse -mw^M^M
map _ws :w !webrowse -sw^M^M		map _ws :w !webrowse -sw^M^M
map _wn :!webrowse -w %^M^M		map _wn :!webrowse -w %^M^M
map _wl :!webrowse %^M^M		map _wl :!webrowse %^M^M
map _ww :!webrowse -c reload^M^M		map _ww :!webrowse -c reload^M^M

The following vim(1) one-line macro, for your .vimrc file, may be used to (re)set the edi-		The following vim(1) one-line macro, for your .vimrc file, may be used to (re)set the edi-

tor's WB_ID environment variable to a selected Netscape browsing win		tor's WB_ID environment variable to a selected Mozilla browsing windo
dow. It requires		w. It requires
xwinid(1) to be installed and WB_NETSCAPE to be defined.		xwinid(1) to be installed and WB_MOZILLA to be defined.


noremap _wi mp:r!xwinid -i $WB_NETSCAPE<CR>0"iy$u`p		noremap _wi mp:r!xwinid -i $WB_MOZILLA<CR>0"iy$u`p
:let $WB_ID=@i<Bar>ec $WB_ID<CR>		:let $WB_ID=@i<Bar>ec $WB_ID<CR>


If you receive a mail message in HTML with mailx(1), the following config uration in your		If you receive a mail message in HTML with mailx(1), the following conf iguration in your
.mailrc file will allow you to view the message in your browser via mailx 's pipe command.		.mailrc file will allow you to view the message in your browser via mailx 's pipe command.

set cmd='webrowse -sw'		set cmd='webrowse -sw'


If you receive a news article containing URLs with nn(1), the following configuration in		If you receive a news article containing URLs with nn(1), the following configuration in
your .nn/init file will allow you to view the article with markup in your browser via nn's		your .nn/init file will allow you to view the article with markup in your browser via nn's
I command.		I command.

map both I (		map both I (
save-full "\|webrowse -mqw"		save-full "\|webrowse -mqw"
)		)


Webrowse may also come in handy as part of a browser startup command.
For example, the
following Bourne-shell command in a shell alias, windowing system initial
ization file or
window manager configuration file will allow you to create a new Netsca
pe/Mozilla window
by spawning one off an already running Netscape/Mozilla browser, if there
is one. If not,
it starts a new Netscape/Mozilla entirely. WWW_HOME is assumed to be set
to your starting
URL.

case "`webrowse -uw $WWW_HOME 2>&1`" in
[Nn]orunning*) exec ${WB_NETSCAPE-netscape} &;;
esac

FILES		FILES

		$HOME/{.cache/chromium,tmp}/webrowse, /tmp/webrowse
		Possible temporary files for markup and loading. The defau
		lts with Chrome
		unless the directory is changed via WB_CHTMP or WB_TMP.

$HOME/{.mozilla,.netscape,tmp}/webrowse, /tmp/webrowse		$HOME/{.mozilla,.netscape,tmp}/webrowse, /tmp/webrowse

Possible temporary files for markup and loading. The def		Possible temporary files for markup and loading. The defaults
aults with Net-		with Mozilla/Net-
scape/Mozilla unless the directory is changed via WB_NSTMP or W		scape unless the directory is changed via WB_MZTMP, WB_NSTMP or
B_TMP.		WB_TMP.

$HOME/tmp/webrowse, /tmp/webrowse		$HOME/tmp/webrowse, /tmp/webrowse

Possible temporary files for markup and loading. The def aults with Mosaic		Possible temporary files for markup and loading. The defau lts with Mosaic
unless the directory is changed via WB_MSTMP or WB_TMP.		unless the directory is changed via WB_MSTMP or WB_TMP.

$HOME/.mosaicpid		$HOME/.mosaicpid
Used to determine the process ID of a Mosaic browser. Created by Mosaic.		Used to determine the process ID of a Mosaic browser. Created by Mosaic.

/tmp/Mosaic.*		/tmp/Mosaic.*
Created, used and kept to communicate loading information to Mo saic.		Created, used and kept to communicate loading information to Mo saic.

CAVEATS		CAVEATS

The textual pattern matching used to identify URLs, shortened URLs, FTP		The textual pattern matching used to identify URLs, shortened URLs, FT
locations, mail		P locations, mail
addresses, header newsgroups, news article IDs, and filesystem pathna		addresses, header newsgroups, news article IDs, and filesystem pathname
mes is completely		s is completely
heuristic and can easily misidentify items. In practice, it's quite accu		heuristic and can easily misidentify items. In practice, it's quite ac
rate, but occa-		curate, but occa-
sionally text is identified as an FTP location (eg, hostname:path) or a		sionally text is identified as an FTP location (eg, hostname:path) or a
filesystem path-		filesystem path-
name when it really isn't. Webrowse is designed to err on the side of		name when it really isn't. Webrowse is designed to err on the side o
overidentifying		f overidentifying
such references, to make it most useful when browsing temporary mark		such references, to make it most useful when browsing temporary markup.
up. Also, if the		Also, if the
input text is exceptionally large, the pattern matching can become prohib itively expensive		input text is exceptionally large, the pattern matching can become prohib itively expensive

to compute. In such cases as these, a different program may be us ed to perform the		to compute. In such cases as these, a different program may be used to perform the
markup, with its output piped into webrowse.		markup, with its output piped into webrowse.


Not all Netscape remote control features may work with Mozilla, too, sinc		Not all Netscape remote control features may work with Mozilla, too, sin
e Mozilla's sup-		ce Mozilla's sup-
port for Netscape-style remote control is still under development. Se		port for Netscape-style remote control wasn't fully implemented. Support
e the URLs in the		ended entirely
SEE ALSO section below for current details.		with Firefox version 36.0. See the URLs in the SEE ALSO section
		below for current
		details.

VERSION		VERSION

1.7.3		2.0.0

AUTHOR		AUTHOR

Steve Kinzler, kinzler@cs.indiana.edu, May 96/Jan 98		Steve Kinzler, steve@kinzler.com, May 96/Jan 98/Feb 15

URL		URL

http://www.cs.indiana.edu/~kinzler/webrowse/ http://www.cs.duke.edu/~des/ webrowse.html		http://kinzler.com/me/webrowse/ http://www.cs.duke.edu/~des/webrowse.html

SEE ALSO		SEE ALSO

netscape(1), mozilla(1), Mosaic(1), umask(1), sleep(1), at(1), xwinid(		chromium-browser(1), firefox(1), mozilla(1), netscape(1), Mosaic(1), uma
1), xwininfo(1),		sk(1), sleep(1),
xlswins(1), pwd(1), kill(1), vi(1), mailx(1), nn(1), http://home.n		at(1), xwinid(1), xwininfo(1), xlswins(1), pwd(1), kill(1), vi(1),
etscape.com/news-		mailx(1), nn(1),
ref/std/x-remote.html, http://www.mozilla.org/unix/remote.html, xdg-open(		http://peter.sh/experiments/chromium-command-line-switches/,
1)		http://www.mozilla.org/unix/remote.html, http://home.netscape.c
		om/newsref/std/x-
		remote.html, xdg-open(1)


1.7.0 WEBROWSE(1)		2.0.0 WEBROWSE(1)

End of changes. 42 change blocks.
200 lines changed or deleted		235 lines changed or added

"Fossies" - the Fresh Open Source Software Archive

Source code changes of the file "webrowse.man" betweenwebrowse-1.7.3.tgz and webrowse-2.0.0.tgz

Source code changes of the file "webrowse.man" between
webrowse-1.7.3.tgz and webrowse-2.0.0.tgz