openpkg-packages/firefox/firefox.pod

##
##  firefox.pod -- Mozilla Firefox Startup Control Utility (manpage)
##  Copyright (c) 2000-2003 The OpenPKG Project <http://www.openpkg.org/>
##  Copyright (c) 2000-2003 Ralf S. Engelschall <rse@engelschall.com>
##  Copyright (c) 2000-2003 Cable & Wireless <http://www.cw.com/>
##
##  Permission to use, copy, modify, and distribute this software for
##  any purpose with or without fee is hereby granted, provided that
##  the above copyright notice and this permission notice appear in all
##  copies.
##
##  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
##  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
##  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
##  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
##  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
##  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
##  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
##  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
##  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
##  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
##  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
##  SUCH DAMAGE.
##

=pod

=head1 NAME

B<firefox> -- Mozilla Firefox Startup Control Utility

=head1 SYNOPSIS

B<firefox>
[B<-v>|B<--verbose>]
[B<-w>|B<--window>]
[B<-t>|B<--tab>]
[B<-r>|B<-remote>|B<--remote> I<command>]
[I<url> ...]

=head1 DESCRIPTION

The B<firefox> command is small startup control utility for the
B<Mozilla Firefox> browser (http://www.mozilla.org/). It makes sure that
no more than one B<Mozilla Firefox> instance is running at the same time
and allows you to conviniently load URLs from the command line into new
browser windows, new browser tabs or into the currently open browser
view.

The following command line options are recognized:

=over 4

=item B<-v>, B<--verbose>

Displays verbose messages on F<stderr> while performing the
B<Mozilla Firefox> control actions.

=item B<-w>, B<--window>

Opens the URL(s) into new browser windows.

=item B<-t>, B<--tab>

Opens the URL(s) into new browser tabs.

=item B<-r>, B<-remote>, B<--remote> I<command>

This is for compatibility with the lower level C<mozilla>
executable. It just passes through the options I<command>.

=back

The following URL(s) are recognized on the command line:

=over 4

=item C<http://>..., C<https://...>, C<ftp://>...

Fully qualified URLs are passed through as-is.

=item C<google:>I<wordlist>

Expands into a Google (http://www.google.com/) query URL for the given
I<wordlist>.

=item C<leo:>I<wordlist>

Expands into a Leo English/German Dictionary (http://dict.leo.org/)
query URL for the given I<wordlist>.

=item C<ftpsearch:>I<wordlist>

Expands into an AllTheWeb FTPSearch (http://www.alltheweb.com/) query URL for the given
I<wordlist>.

=item C<rfc:>I<number>

Expands into a Zvon RFC retrival URL (http://zvon.org/) for the given
RFC I<number>.

=item C<whois:>I<domain>

Expands into a Geektools WHOIS query (http://www.geektools.com/) query URL
for the given I<domain>.

=item C</>I<path>, I<path>

Expands the absolute or relative Unix filesystem I<path> into a fully
qualified C<file> scheme URL.

=item C<auto:>...

Trys to autodetect the query.

=back 

Additionally any URL argument can contain an at-sign ("C<@>"), which
is replaced with the current contents of the X11 selection buffer.

=head1 SEE ALSO

http://www.mozilla.org/unix/remote.html

=head1 HISTORY

This utility was written in November 2002 by B<Ralf S. Engelschall>
E<lt>rse@engelschall.comE<gt> for use with the B<OpenPKG> I<mozilla>
package.

=cut