PageRenderTime 43ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 0ms

/surfraw-2.2.8/README

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