PageRenderTime 2ms CodeModel.GetById 2ms app.highlight 159ms RepoModel.GetById 9ms app.codeStats 1ms

/surfraw-2.2.8/README

#
#! | 370 lines | 308 code | 62 blank | 0 comment | 0 complexity | b08f8fe182485495c5e70bf2363ae7d2 MD5 | raw file
  1
  2        Surfraw - Shell Users' Revolutionary Front Rage Against the Web
  3
  4Home Page: http://surfraw.alioth.debian.org
  5
  6        ______  _     _  ______   _______  ______   _______  _  _  _
  7       / _____)(_)   (_)(_____ \ (_______)(_____ \ (_______)(_)(_)(_)
  8      ( (____   _     _  _____) ) _____    _____) ) _______  _  _  _
  9       \____ \ | |   | ||  __  / |  ___)  |  __  / |  ___  || || || |
 10       _____) )| |___| || |  \ \ | |      | |  \ \ | |   | || || || |
 11      (______/  \_____/ |_|   |_||_|      |_|   |_||_|   |_| \_____/
 12
 13   Surfraw - Shell Users' Revolutionary Front Rage Against the Web
 14		 New: http://surfraw.alioth.debian.org
 15		 Old: http://surfraw.sourceforge.net/
 16
 17			       Oh Baybe
 18			     I need some
 19			     Deep Linking
 20			      Let us go
 21			 Surfin' in the raw!
 22
 23  Surfraw provides a fast unix command line interface to a variety of
 24  popular WWW search engines and other artifacts of power. It reclaims
 25  google, altavista, babelfish, dejanews, freshmeat, research index,
 26  slashdot and many others from the false-prophet, pox-infested heathen
 27  lands of html-forms, placing these wonders where they belong, deep in
 28  unix heartland, as god loving extensions to the shell.
 29
 30  Surfraw abstracts the browser away from input. Doing so lets it get on
 31  with what it's good at. Browsing. Interpretation of linguistic forms
 32  is handed back to the shell, which is what it, and human beings are
 33  good at. Combined with netscape-remote or incremental text browsers,
 34  such as links (http://artax.karlin.mff.cuni.cz/~mikulas/links/), w3m
 35  (http://www.w3m.org/), and screen(1) a Surfraw liberateur is capable
 36  of navigating speeds that leave GUI tainted idolaters agape with fear
 37  and wonder.
 38
 39  Surfraw consists of a collection of elvi, each of which knows how
 40  to search a specific web site.
 41  To see the list of elvi type:
 42
 43   surfraw -elvi
 44
 45  Note that sr is an alias for surfraw, so that could equally be
 46
 47   sr -elvi
 48
 49  To search using an elvis use:
 50
 51   sr elviname [options] search terms..
 52
 53  For example, to search google for information on Debian ports,
 54  using the "I'm feeling lucky" option:
 55
 56   sr google -l debian ports
 57
 58  Note that putting quotes round arguments works now, so you can do,
 59  for example:
 60
 61   sr google foo "bar baz" bam
 62
 63  and the quoting is passed on to the search engine.
 64
 65ADDING THE ELVI TO YOUR PATH
 66
 67  If you are a regular user of surfraw, you will probably get sick
 68  of typing sr or surfraw each time. You can regain the old
 69  behaviour of running the elvi directly by adding the elvi
 70  directory (usually /usr/lib/surfraw or /usr/local/lib/surfraw/) to
 71  your path, either manually or using surfraw-update-path(1).
 72
 73CONFIG FILES
 74
 75  Surfraw implements the XDG basedir spec
 76  (http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html)
 77
 78  Essentially this means global config will be in /etc/xdg/surfraw/
 79  and local config will be in $HOME/.config/surfraw/.
 80  This can be modified by setting $XDG_CONFIG_DIRS and $XDG_CONFIG_HOME,
 81  see the spec for more details.
 82
 83  If your system has a different sysconfdir set during configure, that
 84  will be used instead of /etc (for instance, /usr/local/etc).
 85
 86  In the documentation below, only the default paths will be referred to.
 87
 88LOCAL ELVI
 89
 90  Surfraw can use your own private elvi, store them in
 91  $HOME/.config/surfraw/elvi/.
 92
 93  Local elvi will be listed separately at the end of
 94  'surfraw -elvi'.
 95
 96  Use existing elvi (e.g. google) as a template. If you think your
 97  elvi may be useful to others, consider submitting them to
 98  surfraw-devel@lists.alioth.debian.org.
 99
100BOOKMARKS
101
102  Surfraw now supports bookmarks. To add a bookmark, add it to to the
103  global bookmark list in /etc/xdg/surfraw/bookmarks or to your
104  personal bookmark list in $HOME/.config/surfraw/bookmarks
105
106  The format of the bookmarks file is simple, each bookmark is on a
107  separate line, with the bookmark and URL separated by whitespace,
108  eg:
109
110   ntk   http://www.ntk.net/
111
112  To invoke a bookmark, use "surfraw bookmark" or "sr bookmark",
113  and if an elvis of that name doesn't exist, it searches for a
114  bookmark of that name instead.
115
116  There are some example bookmarks in /etc/xdg/surfraw/bookmarks
117
118INSTALLATION
119
120  Surfraw is installed with the standard ./configure; make; make install
121  procedure. See INSTALL for more details. If you obtained surfraw
122  direct from the git repository rather than a release tarball, run
123  ./prebuild to generate the autotools build files *before* running
124  ./configure.
125
126  Note that the opensearch elvis depends on the perl libraries
127  WWW::OpenSearch, HTML::Parser and LWP (libwww-perl). If you don't
128  want to install opensearch, use ./configure --disable-opensearch.
129
130  Surfraw supports the following options to ./configure:
131
132    --with-text-browser=BROWSER       Use BROWSER as text-mode browser
133    --with-graphical-browser=BROWSER  Use BROWSER as graphical-mode browser
134    --with-elvidir=DIR                Use DIR as location for storing elvi
135    --disable-opensearch              Disable OpenSearch support
136    --disable-sr                      Disable installing sr alias
137
138    By default, the text and graphical browsers are detected from a
139    list of installed browsers at configure time. elvidir defaults
140    to $(libdir)/surfraw (probably /usr/local/lib/surfraw).
141
142EXAMPLES
143
144         $ surfraw google -results=100 RMS, GNU, which is sinner, which is sin?
145         $ sr wikipedia surfraw
146         $ sr austlii -method=phrase dog like
147         $ /usr/lib/surfraw/rhyme -method=perfect Julian
148
149OPTIONS
150
151  Global options are common to all Surfraw elvi (clients). You can
152  get a list of the currently installed elvi by just typing `surfraw -elvi'.
153  For example:
154
155  $ surfraw -elvi
156 GLOBAL ELVI:
157W               -- Activate Surfraw defined web-browser
158acronym         -- Look for acronyms definitions (www.acronymfinder.com)
159ads             -- Search SAO/NASA Astrophysics Data System
160alioth          -- Search Alioth (alioth.debian.org)
161amazon          -- Search the amazon.com bookstore
162archpkg         -- Search Arch Linux packages (www.archlinux.org)
163archwiki        -- Search the Arch Linux Wiki
164arxiv           -- Search arXiv E-Print Archive for articles
165ask             -- Question the web using Ask Jeeves (www.ask.com)
166aur             -- Search aur.archlinux.org for PKGBUILDs
167austlii         -- Search Australian Law docs (www.austlii.edu.au)
168bbcnews         -- Search BBC News (news.bbc.co.uk)
169bing            -- Search the web using Microsoft's Bing (www.bing.com)
170bookfinder      -- Search for books using www.bookfinder.com
171bugmenot        -- Bypass compulsory web registration with bugmenot.com
172bugzilla        -- Search for bugs on Bugzilla bugtrackers
173cablesearch     -- search openports for OpenBSD packages
174cia             -- Search CIA documents at www.cia.gov
175cite            -- Search computer science papers (citeseerx.ist.psu.edu)
176cliki           -- Search the common lisp wiki
177cnn             -- Search on CNN (cnn.com)
178codesearch      -- Search source code using Google Code Search (www.google.com/codesearch)
179comlaw          -- Search Australian Law using Comlaw (www.comlaw.gov.au)
180ctan            -- Search the Comprehensive TeX Archive Network (ctan.org)
181currency        -- Convert currencies with the Universal Currency Converter (www.xe.net/ucc)
182cve             -- Search for CAN assignments in CVE
183debbugs         -- Search the debian BTS (bugs.debian.org)
184debcontents     -- Search contents of debian/ubuntu packages (packages.debian.org/packages.ubuntu.com)
185deblists        -- Search debian mailing lists (lists.debian.org/search.html)
186deblogs         -- Show changelogs for a package in Debian main (changelogs.debian.net)
187debpackages     -- Search debian/ubuntu packages (packages.debian.org/packages.ubuntu.com)
188debpkghome      -- Visit the home page for a Debian package
189debpts          -- Search the Debian Package Tracking System (packages.qa.debian.org)
190debsec          -- Search the Debian Security Tracker for CVE ids or package names
191debvcsbrowse    -- Browse the VCS repository for a Debian package
192debwiki         -- Search the Debian Wikis (wiki.debian.org & women.debian.org/wiki)
193deja            -- Search usenet using Google Groups (groups.google.com)
194deli            -- Search Delicious bookmarks
195discogs         -- Search the Discogs database of music information (www.discogs.com)
196dmoz            -- Search the Open Directory Project web directory (dmoz.org)
197duckduckgo      -- Securely search the web using duckduckgo (www.duckduckgo.com)
198ebay            -- Search the Ebay auction site
199etym            -- Look up word origins at www.etymonline.com
200excite          -- Search on Excite (www.excite.com)
201finkpkg         -- Search Fink packages (pdb.finkproject.org)
202foldoc          -- The Free On-Line Dictionary Of Computing (foldoc.org)
203freebsd         -- Search FreeBSD related information (www.freebsd.org)
204freedb          -- Search for cd track listings in FreeDB (www.freedb.org)
205freshmeat       -- Search Freshmeat (www.freshmeat.net)
206fsfdir          -- Search the FSF/UNESCO Free Software Directory (directory.fsf.org)
207gcache          -- Search the web using Google cache (www.google.com)
208genbugs         -- Search the Gentoo bug tracker (bugs.gentoo.org)
209genportage      -- Search gentoo-portage.com for packages
210google          -- Search the web using Google (www.google.com)
211gutenberg       -- Search for books on Project Gutenberg (gutenberg.org)
212happypenguin    -- Search the Linux Game Tome (www.happypenguin.org)
213imdb            -- Search the Internet Movie Database (www.imdb.com)
214ixquick         -- Search the web using ixquick [HTTPS] (www.ixquick.com)
215jamendo         -- Search Jamendo: free music with Creative Commons licenses (www.jamendo.com)
216javasun         -- Search Java API docs (java.sun.com)
217l1sp            -- Search lisp documentation
218lastfm          -- Search last.fm
219leodict         -- Search Leo's German <-> English dictionary (dict.leo.org)
220lsm             -- Search the Linux Software Map
221macports        -- Search macports packages (macports.org)
222mathworld       -- Search Wolfram MathWorld
223mininova        -- Search the mininova bittorent source.
224musicbrainz     -- Search MusicBrainz (musicbrainz.org)
225netbsd          -- Search NetBSD related information (www.netbsd.org)
226ntrs            -- Search the NASA Technical Report Server
227openbsd         -- Search OpenBSD related information (www.openbsd.org)
228openports       -- search openports for OpenBSD packages
229opensearch      -- Search an OpenSearch-enabled website
230pasearch        -- Search the unofficial Penny Arcade archives (pipefour.org/pa)
231pgpkeys         -- Search the PGP key database
232piratebay       -- Search thepiratebay.org for torrents
233pubmed          -- Search medical/molbio databases (www.ncbi.nlm.nih.gov)
234rae             -- Busca en el diccionario de la Real Academia de la Lengua Espa?ola (Spanish Dictionary)
235rfc             -- Search RFCs (internet standards documents)
236rhyme           -- Search for rhymes et al using Lycos Rhyme (rhyme.lycos.com)
237rpmsearch       -- Search for RPMs in various distros
238scholar         -- Search Google Scholar (scholar.google.com)
239scicom          -- Search Scientific Commons
240scirus          -- Search for science using Scirus (scirus.com)
241scitopia        -- Search for science with scitopia.org
242scpan           -- Search the Comprehensive Perl Archive Network (search.cpan.org)
243scroogle        -- Search Google anonymously via Scroogle (www.scroogle.org)
244slashdot        -- Search stories on Slashdot (www.slashdot.org)
245slinuxdoc       -- Search entries in LDP (www.linuxdoc.org)
246sourceforge     -- Search SourceForge (www.sourceforge.net)
247springer        -- Search Springer for Books and Articles
248stack           -- Search Stack Overflow
249stockquote      -- Get a single stock quote (multiple providers)
250sunonesearch    -- Search Sun One Search (onesearch.sun.com)
251thesaurus       -- Look up word in Merriam-Webster's Thesaurus (www.m-w.com)
252translate       -- Translate human languages (various providers)
253urban           -- Search urbandictionary.com for a definition
254w3css           -- Validate a CSS URL with the w3c CSS validator (jigsaw.w3.org/css-validator)
255w3html          -- Validate a web page URL with the w3c validator (validator.w3.org)
256w3link          -- Check web page links with the w3c linkchecker (validator.w3.org/checklink)
257w3rdf           -- Validate a RDF URL with the w3c RDF validator (validator.w3.org)
258wayback         -- Search The Internet Archive's Wayback Machine for a URL (archive.org)
259webster         -- Look up word in Merriam-Webster's Dictionary (www.m-w.com)
260wetandwild      -- Real time weather information (many sources)
261wikipedia       -- Search the free encyclopedia wikipedia
262woffle          -- Search the web using Woffle (localhost:8080)
263worldwidescience        -- Search for science with www.worldwidescience.org
264yahoo           -- Search Yahoo categories (www.yahoo.com)
265yandex          -- Search the web using Yandex (yandex.ru)
266youtube         -- Search YouTube (www.youtube.com)
267yubnub          -- Use the social command-line for the web (yubnub.org)
268
269  All elvi have useful low calorie help, for example:
270
271Usage: rhyme [options] [search words]...
272Description:
273  Surfraw search for rhymes and other word correlations using
274  Lycos Rhyme (rhyme.lycos.com)
275Example:
276  $ rhyme Julian
277  $ rhyme -method=rel surfer
278Results:
279  Hurclean St. Julien.
280  surfboarder, bather, natator, swimmer
281Local options:
282  -method=                      Type of word correlation to search for
283          prefect       |       Perfect rhyme
284          syn           |       Synonyms
285          hom           |       Homophones
286          cons          |       Consonsant rhymes only
287          rel           |       Semantically related words
288          sub           |       Phrases
289          spell         |       Similar spellings
290          pic           |       Pictures
291          shake         |       Match with Shakespeare archives
292          def                   Find wordnet definition
293                                Default: perfect
294                                Environment: SURFRAW_rhyme_method
295Global options:
296  -browser=EXECUTABLE           Set browser
297                                Default: sensible-browser
298  -elvi                         List Surfraw mechanisms for conquering evil
299  -escape-url-args=yes|no       Apply url escaping to arguments
300                                Default: yes
301                                Environment: SURFRAW_escape_url_args
302  -g | -graphical               Get some windowed sin
303                                Default: yes
304                                Environment: SURFRAW_graphical
305  -help                         What you're reading now, dude
306  -lh | -local-help             Just show elvi-specific help, not the global options
307  -p | -print                   Just print search URL, don't pass to browser
308  -o | -o=FILE                  Fetch URL and dump to stdout or FILE.
309  -new[=yes|no]                 Start in a new window
310                                Default: no
311                                Environment: SURFRAW_new_window
312  -t | -text                    Back to the yellow brick road
313  -q | -quote                   Quote arguments with " characters
314                                Default: no
315                                Environment: SURFRAW_quote_args
316  -version                      Display Surfraw version (2.2.7)
317  --                            End of options
318Copyright:
319  Copyright (c) 2003-2010 The Surfraw-Devel Team
320                           <surfraw-devel@lists.alioth.debian.org>
321  Copyright (c) 2000-2001 Julian Assange <proff@iq.org>
322  Copyright (c) 2001 Australian Institute for Collaborative Research
323  Copyright (c) 2000 Melbourne Institute for Advanced Study
324
325  If you just want to see the elvi-specific help, use
326  elvi -lh or -local-help.
327
328  The system wide configuration file can usually be found in
329  /etc/xdg/surfraw/conf (but see 'Config files' above). This can be
330  overridden by setting the environment variable SURFRAW_global_conf.
331
332  Each user can also specify their own overrides, usually in
333  $HOME/.config/surfraw/conf (again, see 'Config files' above).  This
334  can be overridden by setting SURFRAW_conf, either in the environment
335  or the global config file.
336
337  e.g
338
339        SURFRAW_graphical_remote=yes
340        SURFRAW_graphical_browser=mozilla
341        SURFRAW_text_browser=w3m
342	SURFRAW_pgpkeys_sigs=on
343
344INTEGRATION
345
346  There is a browser plugin for Pentadactyl (a vimperator fork) at
347  http://code.google.com/p/dactyl/issues/detail?id=320
348  For details, see:
349  http://lists.alioth.debian.org/pipermail/surfraw-devel/2011-April/000916.html
350
351  Code to integrate with uzbl is in
352  examples/uzbl_load_url_from_surfraw
353
354RADICALIZATION
355
356  Read HACKING. Surfrawize the soul of your favourite internet wonder.
357  Join the Shell Users' Revolutionary Front Against the WWW by
358  submitting code. Reclaim heathen lands. Bear witness to the
359  truth. Its love will set you free.
360
361  Join us on surfraw-devel@lists.alioth.debian.org
362     _________________________________________________________________
363
364README originally by Julian Assange
365Updated by Ian Beckwith
366     _________________________________________________________________
367
368See NEWS, and ChangeLog for a summary of changes.
369     _________________________________________________________________
370