OPENSEA...GENQUERY(1)

📦
version 2.3.0 · 5 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

💖 OPENSEARCH-GENQUERY 💖

okay bestie, listen up — this is opensearch-genquery, one of the little Perl tools from the User Contributed Perl Documentation collection. She's a command-line girlie who takes an OpenSearch Description file and spits out the URL of a query. That's the whole vibe. 🎀

✨ NAME ✨

opensearch-genquery — outputs the URL of a query generated from an OpenSearch Description. literally that's her whole job and she does it flawlessly. 💅

🌸 SYNOPSIS 🌸

opensearch-genquery [-q] [-H] [-A] [-R] [-c COUNT] [-i INDEX]
[-p PAGENUM] [-l LANG] [-O ENC] [-I ENC] URL SEARCH TERMS...

🦋 DESCRIPTION 🦋

So here's the tea, bestie: you hand her a URL pointing at an OpenSearch Description file, you throw in your SEARCH TERMS plus whatever other options you want filled in, and she hands you back the URL of a query generated from that description. iconic behaviour, no cap. ✨

If the description file has multiple search types on offer (very main character of it), you can use -H, -A and -R to say which type you actually want. For example, -A -R is you going "give me an Atom response… or bestie, if you can't do that, fall back to RSS, I'm flexible." 💁‍♀️ By default she just uses the first URL found in the description file — first come, first served, periodt.

Now the real talk: not all web sites implement all (or even any) of the optional OpenSearch parameters. And when you use those options on those sites? The corresponding options get silently ignored. No error, no drama, just… nothing. She's not going to yell at you about it. 🙈

👑 OPTIONS 👑

  • -q — give no output on errors. Yep, she goes quiet. In that case you gotta consult the exit code to figure out what went wrong (go peek at DIAGNOSTICS, bestie). 🤫
  • -H — request an HTML response.
  • -A — request an Atom response.
  • -R — request an RSS response.
  • -H, -A, and -R can be combined to express response type priority and specify fallback types. so you can stack your faves in order of preference. slay. 💅
  • -c COUNT, --count=COUNT — request COUNT results. OpenSearch parameter: count.
  • -i INDEX, --startindex=INDEX — request results start at offset NUM. OpenSearch parameter: startIndex.
  • -p PAGENUM, --startpage=PAGENUM — request results page PAGENUM. OpenSearch parameter: pageIndex.
  • -l LANG, --language=LANG — request results in LANG. LANG should be a 2-letter ISO country code (like en or de, iykyk 🌍). OpenSearch parameter: language.
  • -O ENC, --outputencoding=ENC — request results encoded in ENC (default: UTF-8). OpenSearch parameter: outputEncoding.
  • -I ENC, --inputencoding=ENC — specify that your search terms are encoded in ENC (default: UTF-8). OpenSearch parameter: inputEncoding.
  • -h, --help — show a short help message. she'll explain herself, briefly. 🫶
  • -- — end of options. that's it, that's the flag. the door is closed. 🚪

💀 DIAGNOSTICS 💀

You can consult the exit code to determine errors, like so:

  • 0 — Success. 🎉 (we love to see it)
  • 1 — Error fetching OpenSearch Description URL.
  • 2 — Error parsing OpenSearch Description.
  • 3 — No matching search type found.
  • 4 — Cannot find perl module WWW::OpenSearch.
  • 5 — Unhandled error from WWW::OpenSearch.

🧚 DEPENDENCIES 🧚

She requires the module WWW::OpenSearch — which is the Debian package libwww-opensearch-perl, if that's your flavour. 💜

😭 BUGS 😭

  • Only supports GET queries. that's it. that's the limit. she's a GET girlie only. 🚫
  • Please report any bugs found to ianb@erislabs.net. tell him bestie sent you. 💌

🌈 SEE ALSO 🌈

💖 AUTHOR 💖

Ian Beckwith <ianb@erislabs.net> — the actual legend behind this whole thing. 👑

Copyright 2006 Ian Beckwith <ianb@erislabs.net>

Licensed under the same terms as surfraw.

okay so that's the whole page, you're fully caught up bestie, go generate some queries 💅✨

perl v5.36.0 · 2022-12-29 — mwah, love u, bye 🫶💖🌸

📦 where this page comes from