PageRenderTime 5ms CodeModel.GetById 4ms app.highlight 89ms RepoModel.GetById 1ms app.codeStats 0ms

/README

https://bitbucket.org/kisom/surfraw-devel
#! | 376 lines | 314 code | 62 blank | 0 comment | 0 complexity | c01637451be2a2b21aefe2da96fefdc3 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/packages/)
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
175cisco           -- Search Cisco documentation (www.cisco.com)
176cite            -- Search computer science papers (citeseerx.ist.psu.edu)
177cliki           -- Search the common lisp wiki
178cnn             -- Search on CNN (cnn.com)
179codesearch      -- Search source code using Google Code Search (www.google.fr/codesearch)
180comlaw          -- Search Australian Law using Comlaw (www.comlaw.gov.au)
181ctan            -- Search the Comprehensive TeX Archive Network (ctan.org)
182currency        -- Convert currencies with the Universal Currency Converter (www.xe.net/ucc)
183cve             -- Search for CAN assignments in CVE
184debbugs         -- Search the debian BTS (bugs.debian.org)
185debcontents     -- Search contents of debian/ubuntu packages (packages.debian.org/packages.ubuntu.com)
186deblists        -- Search debian mailing lists (lists.debian.org/search.html)
187deblogs         -- Show changelogs for a package in Debian main (changelogs.debian.net)
188debpackages     -- Search debian/ubuntu packages (packages.debian.org/packages.ubuntu.com)
189debpkghome      -- Visit the home page for a Debian package
190debpts          -- Search the Debian Package Tracking System (packages.qa.debian.org)
191debsec          -- Search the Debian Security Tracker for CVE ids or package names
192debvcsbrowse    -- Browse the VCS repository for a Debian package
193debwiki         -- Search the Debian Wikis (wiki.debian.org & women.debian.org/wiki)
194deja            -- Search usenet using Google Groups (groups.google.com)
195deli            -- Search Delicious bookmarks
196discogs         -- Search the Discogs database of music information (www.discogs.com)
197dmoz            -- Search the Open Directory Project web directory (dmoz.org)
198duckduckgo      -- Securely search the web using duckduckgo (www.duckduckgo.com)
199ebay            -- Search the Ebay auction site
200etym            -- Look up word origins at www.etymonline.com
201excite          -- Search on Excite (www.excite.com)
202f5              -- Search F5 related information (www.f5.com)
203finkpkg         -- Search Fink packages (pdb.finkproject.org)
204foldoc          -- The Free On-Line Dictionary Of Computing (foldoc.org)
205freebsd         -- Search FreeBSD related information (www.freebsd.org)
206freedb          -- Search for cd track listings in FreeDB (www.freedb.org)
207freshmeat       -- Search Freshmeat (www.freshmeat.net)
208fsfdir          -- Search the FSF/UNESCO Free Software Directory (directory.fsf.org)
209gcache          -- Search the web using Google cache (www.google.com)
210genbugs         -- Search the Gentoo bug tracker (bugs.gentoo.org)
211genportage      -- Search gentoo-portage.com for packages
212github          -- Search github for code (www.github.com)
213google          -- Search the web using Google (www.google.com)
214gutenberg       -- Search for books on Project Gutenberg (gutenberg.org)
215happypenguin    -- Search the Linux Game Tome (www.happypenguin.org)
216imdb            -- Search the Internet Movie Database (www.imdb.com)
217ixquick         -- Search the web using ixquick [HTTPS] (www.ixquick.com)
218jamendo         -- Search Jamendo: free music with Creative Commons licenses (www.jamendo.com)
219javasun         -- Search Java API docs (java.sun.com)
220l1sp            -- Search lisp documentation
221lastfm          -- Search last.fm
222leodict         -- Search Leo's German <-> English dictionary (dict.leo.org)
223lsm             -- Search the Linux Software Map
224macports        -- Search macports packages (macports.org)
225mathworld       -- Search Wolfram MathWorld
226mininova        -- Search the mininova bittorent source.
227musicbrainz     -- Search MusicBrainz (musicbrainz.org)
228netbsd          -- Search NetBSD related information (www.netbsd.org)
229ntrs            -- Search the NASA Technical Report Server
230openbsd         -- Search OpenBSD related information (www.openbsd.org)
231openports       -- search openports for OpenBSD packages
232opensearch      -- Search an OpenSearch-enabled website
233pasearch        -- Search the unofficial Penny Arcade archives (pipefour.org/pa)
234pgpkeys         -- Search the PGP key database
235pin             -- Search Pinboard bookmarks (http://pinboard.in)
236piratebay       -- Search thepiratebay.org for torrents
237priberam        -- Look up word in Priberam online dictionary (www.priberam.pt/dlpo)
238pubmed          -- Search medical/molbio databases (www.ncbi.nlm.nih.gov)
239rae             -- Busca en el diccionario de la Real Academia de la Lengua EspaĂąola (Spanish Dictionary)
240rfc             -- Search RFCs (internet standards documents)
241rhyme           -- Search for rhymes et al using Lycos Rhyme (rhyme.lycos.com)
242rpmsearch       -- Search for RPMs in various distros
243scholar         -- Search Google Scholar (scholar.google.com)
244scicom          -- Search Scientific Commons
245scirus          -- Search for science using Scirus (scirus.com)
246scitopia        -- Search for science with scitopia.org
247scpan           -- Search the Comprehensive Perl Archive Network (search.cpan.org)
248scroogle        -- Search Google anonymously via Scroogle (www.scroogle.org)
249slashdot        -- Search stories on Slashdot (www.slashdot.org)
250slinuxdoc       -- Search entries in LDP (www.linuxdoc.org)
251sourceforge     -- Search SourceForge (www.sourceforge.net)
252springer        -- Search Springer for Books and Articles
253stack           -- Search Stack Overflow
254stockquote      -- Get a single stock quote (multiple providers)
255sunonesearch    -- Search Sun One Search (onesearch.sun.com)
256thesaurus       -- Look up word in Merriam-Webster's Thesaurus (www.m-w.com)
257translate       -- Translate human languages (various providers)
258urban           -- Search urbandictionary.com for a definition
259w3css           -- Validate a CSS URL with the w3c CSS validator (jigsaw.w3.org/css-validator)
260w3html          -- Validate a web page URL with the w3c validator (validator.w3.org)
261w3link          -- Check web page links with the w3c linkchecker (validator.w3.org/checklink)
262w3rdf           -- Validate a RDF URL with the w3c RDF validator (validator.w3.org)
263wayback         -- Search The Internet Archive's Wayback Machine for a URL (archive.org)
264webster         -- Look up word in Merriam-Webster's Dictionary (www.m-w.com)
265wetandwild      -- Real time weather information (many sources)
266wikipedia       -- Search the free encyclopedia wikipedia
267woffle          -- Search the web using Woffle (localhost:8080)
268wolfram         -- Ask questions of the computational knowledge engine
269worldwidescience        -- Search for science with www.worldwidescience.org
270yahoo           -- Search Yahoo categories (www.yahoo.com)
271yandex          -- Search the web using Yandex (yandex.ru)
272youtube         -- Search YouTube (www.youtube.com)
273yubnub          -- Use the social command-line for the web (yubnub.org)
274
275  All elvi have useful low calorie help, for example:
276
277Usage: rhyme [options] [search words]...
278Description:
279  Surfraw search for rhymes and other word correlations using
280  Lycos Rhyme (rhyme.lycos.com)
281Example:
282  $ rhyme Julian
283  $ rhyme -method=rel surfer
284Results:
285  Hurclean St. Julien.
286  surfboarder, bather, natator, swimmer
287Local options:
288  -method=                      Type of word correlation to search for
289          prefect       |       Perfect rhyme
290          syn           |       Synonyms
291          hom           |       Homophones
292          cons          |       Consonsant rhymes only
293          rel           |       Semantically related words
294          sub           |       Phrases
295          spell         |       Similar spellings
296          pic           |       Pictures
297          shake         |       Match with Shakespeare archives
298          def                   Find wordnet definition
299                                Default: perfect
300                                Environment: SURFRAW_rhyme_method
301Global options:
302  -browser=EXECUTABLE           Set browser
303                                Default: sensible-browser
304  -elvi                         List Surfraw mechanisms for conquering evil
305  -escape-url-args=yes|no       Apply url escaping to arguments
306                                Default: yes
307                                Environment: SURFRAW_escape_url_args
308  -g | -graphical               Get some windowed sin
309                                Default: yes
310                                Environment: SURFRAW_graphical
311  -help                         What you're reading now, dude
312  -lh | -local-help             Just show elvi-specific help, not the global options
313  -p | -print                   Just print search URL, don't pass to browser
314  -o | -o=FILE                  Fetch URL and dump to stdout or FILE.
315  -new[=yes|no]                 Start in a new window
316                                Default: no
317                                Environment: SURFRAW_new_window
318  -t | -text                    Back to the yellow brick road
319  -q | -quote                   Quote arguments with " characters
320                                Default: no
321                                Environment: SURFRAW_quote_args
322  -version                      Display Surfraw version (2.2.7)
323  --                            End of options
324Copyright:
325  Copyright (c) 2003-2010 The Surfraw-Devel Team
326                           <surfraw-devel@lists.alioth.debian.org>
327  Copyright (c) 2000-2001 Julian Assange <proff@iq.org>
328  Copyright (c) 2001 Australian Institute for Collaborative Research
329  Copyright (c) 2000 Melbourne Institute for Advanced Study
330
331  If you just want to see the elvi-specific help, use
332  elvi -lh or -local-help.
333
334  The system wide configuration file can usually be found in
335  /etc/xdg/surfraw/conf (but see 'Config files' above). This can be
336  overridden by setting the environment variable SURFRAW_global_conf.
337
338  Each user can also specify their own overrides, usually in
339  $HOME/.config/surfraw/conf (again, see 'Config files' above).  This
340  can be overridden by setting SURFRAW_conf, either in the environment
341  or the global config file.
342
343  e.g
344
345        SURFRAW_graphical_remote=yes
346        SURFRAW_graphical_browser=mozilla
347        SURFRAW_text_browser=w3m
348	SURFRAW_pgpkeys_sigs=on
349
350INTEGRATION
351
352  There is a browser plugin for Pentadactyl (a vimperator fork) at
353  http://code.google.com/p/dactyl/issues/detail?id=320
354  For details, see:
355  http://lists.alioth.debian.org/pipermail/surfraw-devel/2011-April/000916.html
356
357  Code to integrate with uzbl is in
358  examples/uzbl_load_url_from_surfraw
359
360RADICALIZATION
361
362  Read HACKING. Surfrawize the soul of your favourite internet wonder.
363  Join the Shell Users' Revolutionary Front Against the WWW by
364  submitting code. Reclaim heathen lands. Bear witness to the
365  truth. Its love will set you free.
366
367  Join us on surfraw-devel@lists.alioth.debian.org
368     _________________________________________________________________
369
370README originally by Julian Assange
371Updated by Ian Beckwith
372     _________________________________________________________________
373
374See NEWS, and ChangeLog for a summary of changes.
375     _________________________________________________________________
376