
        Surfraw - Shell Users' Revolutionary Front Rage Against the Web

Original Home Page: http://surfraw.sourceforge.net/

New project home page: http://surfraw.alioth.debian.org

        ______  _     _  ______   _______  ______   _______  _  _  _
       / _____)(_)   (_)(_____ \ (_______)(_____ \ (_______)(_)(_)(_)
      ( (____   _     _  _____) ) _____    _____) ) _______  _  _  _
       \____ \ | |   | ||  __  / |  ___)  |  __  / |  ___  || || || |
       _____) )| |___| || |  \ \ | |      | |  \ \ | |   | || || || |
      (______/  \_____/ |_|   |_||_|      |_|   |_||_|   |_| \_____/

   Surfraw - Shell Users' Revolutionary Front Rage Against the Web
		 Old: http://surfraw.sourceforge.net/
		 New: http://surfraw.alioth.debian.org

			       Oh Baybe
			     I need some
			     Deep Linking
			      Let us go
			 Surfin' in the raw!

  Surfraw provides a fast unix command line interface to a variety of
  popular WWW search engines and other artifacts of power. It reclaims
  google, altavista, babelfish, dejanews, freshmeat, research index,
  slashdot and many others from the false-prophet, pox-infested heathen
  lands of html-forms, placing these wonders where they belong, deep in
  unix heartland, as god loving extensions to the shell.

  Surfraw abstracts the browser away from input. Doing so lets it get on
  with what it's good at. Browsing. Interpretation of linguistic forms
  is handed back to the shell, which is what it, and human beings are
  good at. Combined with netscape-remote or incremental text browsers,
  such as links (http://artax.karlin.mff.cuni.cz/~mikulas/links/), w3m
  (http://www.w3m.org/), and screen(1) a Surfraw liberateur is capable
  of navigating speeds that leave GUI tainted idolaters agape with fear
  and wonder.

  Surfraw consists of a collection of elvi, each of which knows how
  to search a specific web site.
  To see the list of elvi type:

   surfraw -elvi

  Note that sr is an alias for surfraw, so that could equally be

   sr -elvi

  To search using an elvis use:

   sr elviname [options] search terms..

  For example, to search google for information on Debian ports,
  using the "I'm feeling lucky" option:

   sr google -l debian ports

  Note that putting quotes round arguments works now, so you can do,
  for example:

   sr google foo "bar baz" bam

  and the quoting is passed on to the search engine.

Adding the elvi to your path

  If you are a regular user of surfraw, you will probably get sick
  of typing sr or surfraw each time. You can regain the old
  behaviour of running the elvi directly by adding the elvi
  directory (usually /usr/lib/surfraw or /usr/local/lib/surfraw/) to
  your path, either manually or using surfraw-update-path(1).

Bookmarks

  Surfraw now supports bookmarks. To add a bookmark, add it to
  /etc/surfraw.bookmarks or $HOME/.surfraw.bookmarks

  The format of the bookmarks file is simple, each bookmark is on a
  separate line, with the bookmark and URL separated by whitespace,
  eg:

   ntk   http://www.ntk.net/

  To invoke a bookmark, use "surfraw bookmark" or "sr bookmark",
  and if an elvis of that name doesn't exist, it searches for a
  bookmark of that name instead.

  There are some example bookmarks in /etc/surfraw.bookmarks

Installation

  Surfraw is installed with the standard ./configure; make; make install
  procedure. See INSTALL for more details. Note that the opensearch elvis
  depends on the perl libraries WWW::OpenSearch, HTML::Parser and
  LWP (libwww-perl). If you don't want to install opensearch, use
  ./configure --disable-opensearch.

Examples

         $ surfraw google -results=100 RMS, GNU, which is sinner, which is sin?
         $ sr wikipedia surfraw
         $ sr austlii -method=phrase dog like
         $ /usr/lib/surfraw/rhyme -method=perfect Julian

Options

  Global options are common to all Surfraw elvi (clients). You can
  get a list of the currently installed elvi by just typing `surfraw'.
  For example:

  $ surfraw -elvi
W		-- Activate Surfraw defined web-browser
alioth		-- Search Alioth (alioth.debian.org)
altavista	-- Search the web using Altavista (www.altavista.com)
amazon		-- Search the amazon.com bookstore
ask		-- Question the web using Ask Jeeves (www.ask.com)
austlii		-- Search Australian Law docs (www.austlii.edu.au)
bbcnews		-- Search BBC News (news.bbc.co.uk)
cddb		-- Search for cd track listings in CDDB (www.gracenote.com)
cia		-- Search CIA documents at www.cia.gov
cite		-- Search computer science papers (www.researchindex.com)
cnn		-- Search on CNN (cnn.com)
codesearch	-- Search source code using Google Code Search (www.google.com/codesearch)
ctan		-- Search the Comprehensive TeX Archive Network (ctan.org)
currency	-- Convert currencies with the Universal Currency Converter (www.xe.net/ucc)
cve		-- Search for CAN assignments in CVE
debbugs		-- Search the debian BTS (bugs.debian.org)
debcontents	-- Search contents of debian/ubuntu packages (packages.debian.org/packages.ubuntu.com)
deblists	-- Search debian mailing lists (lists.debian.org/search.html)
deblogs		-- Show changelogs for a package in Debian main (changelogs.debian.net)
debpackages	-- Search debian/ubuntu packages (packages.debian.org/packages.ubuntu.com)
debpts		-- Search the Debian Package Tracking System (packages.qa.debian.org)
debsec		-- Search the Debian Security Tracker for CVE ids or package names
debwiki		-- Search the Debian Wikis (wiki.debian.org & women.debian.org/wiki)
deja		-- Search usenet using Google Groups (groups.google.com)
discogs		-- Search the Discogs database of music information (www.discogs.com)
dmoz		-- Search the Open Directory Project web directory (dmoz.org)
ebay		-- Search the Ebay auction site
etym		-- Look up word origins at www.etymonline.com
excite		-- Search on Excite (www.excite.com)
fast		-- Search the web using FAST Search (www.alltheweb.com)
filesearching	-- Search files on filesearching (www.filesearching.com)
foldoc		-- The Free On-Line Dictionary Of Computing (foldoc.org)
freebsd		-- Search FreeBSD related information (www.freebsd.org)
freedb		-- Search for cd track listings in FreeDB (www.freedb.org)
freshmeat	-- Search Freshmeat (www.freshmeat.net)
fsfdir		-- Search the FSF/UNESCO Free Software Directory (directory.fsf.org)
genpkg		-- Search Gentoo packages (packages.gentoo.org)
google		-- Search the web using Google (www.google.com)
gutenberg	-- Search for books on Project Gutenberg (gutenberg.org)
happypenguin	-- Search the Linux Game Tome (www.happypenguin.org)
imdb		-- Search the Internet Movie Database (www.imdb.com)
ixquick		-- Search the web using ixquick (www.ixquick.com)
lastfm		-- Search last.fm
leodict		-- Search Leo's German <-> English dictionary (dict.leo.org)
musicbrainz	-- Search MusicBrainz (musicbrainz.org)
netbsd		-- Search NetBSD related information (www.netbsd.org)
openbsd		-- Search OpenBSD related information (www.openbsd.org)
opensearch	-- Search an OpenSearch-enabled website
pgpkeys		-- Search the PGP key database
port		-- Look up a TCP/UDP port number on seifried.org/security/ports/
pubmed		-- Search medical/molbio databases (www.ncbi.nlm.nih.gov)
rae		-- Busca en el diccionario de la Real Academia de la Lengua Espaņola (Spanish Dictionary)
rfc		-- Search RFCs (internet standards documents)
rhyme		-- Search for rhymes et al using Lycos Rhyme (rhyme.lycos.com)
scaleplus	-- Search Australian Law using ScalePlus (scaleplus.law.gov.au)
scholar		-- Search Google Scholar (scholar.google.com)
scpan		-- Search the Comprehensive Perl Archive Network (search.cpan.org)
slashdot	-- Search stories on Slashdot (www.slashdot.org)
slinuxdoc	-- Search entries in LDP (www.linuxdoc.org)
sourceforge	-- Search SourceForge (www.sourceforge.net)
stockquote	-- Get a single stock quote (multiple providers)
sundocs		-- Search docs on Sun.com (docs.sun.com)
sunsolve	-- Search public docs on Sunsolve (sunsolve.sun.com)
thesaurus	-- Look up word in Merriam-Webster's Thesaurus (www.m-w.com)
translate	-- Translate human languages (various providers)
w3css		-- Validate a CSS URL with the w3c CSS validator (jigsaw.w3.org/css-validator)
w3html		-- Validate a web page URL with the w3c validator (validator.w3.org)
w3link		-- Check web page links with the w3c linkchecker (validator.w3.org/checklink)
w3rdf		-- Validate a RDF URL with the w3c RDF validator (validator.w3.org)
wayback		-- Search The Internet Archive's Wayback Machine for a URL (archive.org)
webster		-- Look up word in Merriam-Webster's Dictionary (www.m-w.com)
wetandwild	-- Real time weather information (many sources)
wikipedia	-- Search the free encyclopedia wikipedia
woffle		-- Search the web using Woffle (localhost:8080)
xxx		-- Superior XXX, hot and ready to press (arXiv.org)
yahoo		-- Search Yahoo categories (www.yahoo.com)
yubnub		-- Use the social command-line for the web (yubnub.org)

  All elvi have useful low calorie help, for example:

Usage: rhyme [options] [search words]...
Description:
  Surfraw search for rhymes and other word correlations using
  Lycos Rhyme (http://rhyme.lycos.com)
Example:
  $ surfraw rhyme Julian
  $ sr rhyme -method=rel surfer
Results:
  Hurclean St. Julien.
  surfboarder, bather, natator, swimmer
Local options:
  -method=                      Type of word correlation to search for
          prefect       |       Perfect rhyme
          syn           |       Synonyms
          hom           |       Homophones
          cons          |       Consonsant rhymes only
          rel           |       Semantically related words
          sub           |       Phrases
          spell         |       Similar spellings
          pic           |       Pictures
          shake         |       Match with Shakespeare archives
          def                   Find wordnet definition
                                Default: perfect
                                Environment: SURFRAW_rhyme_method
Global options:
  -browser=EXECUTABLE           Set browser
                                Default: mozilla
  -elvi                         List Surfraw mechanisms for conquering evil
  -escape-url-args=yes|no       Apply url escaping to arguments
                                Default: yes
                                Environment: SURFRAW_escape_url_args
  -g | -graphical               Get some windowed sin
  -help                         What you're reading now, dude
  -quiet=yes|no                 I can't enjoy it with you talking all the time
                                Default: no
                                Environment: SURFRAW_quiet
  -new[=yes|no]                 Start in a new window
                                Default: no
                                Environment: SURFRAW_new_window
  -t | -text                    Back to the yellow brick road
  -q | -quote                   Quote arguments with " characters
                                Default: no
                                Environment: SURFRAW_quote_args
  -version                      Display Surfraw version (1.0.4)
Copyright:
  Copyright (c) 2003-2007 The Surfraw-Devel Team
                           <surfraw-devel@lists.alioth.debian.org>
  Copyright (c) 2000-2001 Julian Assange
  Copyright (c) 2001 Australian Institute for Collaborative Research
  Copyright (c) 2000 Melbourne Institute for Advanced Study
  ---

  The system wide configuration file can be found in:

        SURFRAW_global_conf     @sysconfdir@/surfraw.conf

  Where @sysconfdir@ is something like /etc, or /usr/local/etc

  Each user can also specify their own overrides in:

         SURFRAW_conf           $HOME/.surfraw.conf

  e.g

        SURFRAW_graphical_remote=yes
        SURFRAW_graphical_browser=mozilla
        SURFRAW_text_browser=w3m

  Read HACKING. Surfrawize the soul of your favourite internet wonder.
  Join the Shell Users' Revolutionary Front Against the WWW by
  submitting code. Reclaim heathen lands. Bear witness to the
  truth. Its love will set you free.

  Join us on surfraw-devel@lists.alioth.debian.org
     _________________________________________________________________

README originally by Julian Assange
Updated 2004-02-03 by Ian Beckwith
     _________________________________________________________________

See NEWS, ChangeLog or debian/changelog for a more detailed summary of changes.
     _________________________________________________________________

  $Id: README,v 1.21 2007-09-13 05:26:20 ianb-guest Exp $
     _________________________________________________________________
