.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OPENSEARCH-GENQUERY 1" .TH OPENSEARCH-GENQUERY 1 "2020-05-25" "perl v5.30.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" opensearch\-genquery \- Output the URL of a query generated from an OpenSearch Description .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBopensearch-genquery\fR [\fB\-q\fR] [\fB\-H\fR] [\fB\-A\fR] [\fB\-R\fR] [\fB\-c\fR\ \fI\s-1COUNT\s0\fR] [\fB\-i\fR\ \fI\s-1INDEX\s0\fR] [\fB\-p\fR\ \fI\s-1PAGENUM\s0\fR] [\fB\-l\fR\ \fI\s-1LANG\s0\fR] [\fB\-O\fR\ \fI\s-1ENC\s0\fR] [\fB\-I\fR\ \fI\s-1ENC\s0\fR] \&\fI\s-1URL\s0\fR \fI\s-1SEARCH\s0\ \s-1TERMS...\s0\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" Output the \s-1URL\s0 of a query generated from an OpenSearch Description file at \fI\s-1URL\s0\fR, with the specified \fI\s-1SEARCH\s0\ \s-1TERMS\s0\fR and other options filled in. .PP If multiple search types are available, \fB\-H\fR, \&\fB\-A\fR and \fB\-R\fR can be used to specify which type is wanted. For example, \fB\-A\ \-R\fR can be used to request an Atom response, or failing that fall back to \s-1RSS.\s0 By default the first \s-1URL\s0 found in the description file is used. .PP Not all web sites implement all (or any) of the optional OpenSearch parameters. When used with those sites, the corresponding options will be silently ignored. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-q\fR" 4 .IX Item "-q" Give no output on errors. In this case, consult the exit code to determine errors (See \*(L"\s-1DIAGNOSTICS\*(R"\s0). .IP "\fB\-H\fR" 4 .IX Item "-H" Request \s-1HTML\s0 response. .IP "\fB\-A\fR" 4 .IX Item "-A" Request Atom response. .IP "\fB\-R\fR" 4 .IX Item "-R" Request \s-1RSS\s0 response. .Sp \&\fB\-H\fR, \fB\-A\fR, and \fB\-R\fR can be combined to express response type priority and specify fallback types. .IP "\fB\-c \s-1COUNT\s0\fR, \fB\-\-count=COUNT\fR" 4 .IX Item "-c COUNT, --count=COUNT" Request \s-1COUNT\s0 results. .Sp OpenSearch parameter: \fIcount\fR. .IP "\fB\-i \s-1INDEX\s0\fR, \fB\-\-startindex=INDEX\fR" 4 .IX Item "-i INDEX, --startindex=INDEX" Request results start at offset \s-1NUM.\s0 .Sp OpenSearch parameter: \fIstartIndex\fR. .IP "\fB\-p \s-1PAGENUM\s0\fR, \fB\-\-startpage=PAGENUM\fR" 4 .IX Item "-p PAGENUM, --startpage=PAGENUM" Request results page \s-1PAGENUM.\s0 .Sp OpenSearch parameter: \fIpageIndex\fR. .IP "\fB\-l \s-1LANG\s0\fR, \fB\-\-language=LANG\fR" 4 .IX Item "-l LANG, --language=LANG" Request results in \s-1LANG. LANG\s0 should be a 2\-letter \s-1ISO\s0 country code (e.g. \fBen\fR or \fBde\fR). .Sp OpenSearch parameter: \fIlanguage\fR. .IP "\fB\-O \s-1ENC\s0\fR, \fB\-\-outputencoding=ENC\fR" 4 .IX Item "-O ENC, --outputencoding=ENC" Request results encoded in \s-1ENC\s0 (default: \s-1UTF\-8\s0). .Sp OpenSearch parameter: \fIoutputEncoding\fR. .IP "\fB\-I \s-1ENC\s0\fR, \fB\-\-inputencoding=ENC\fR" 4 .IX Item "-I ENC, --inputencoding=ENC" Specify search terms are encoded in \s-1ENC\s0 (default: \s-1UTF\-8\s0). .Sp OpenSearch parameter: \fIinputEncoding\fR. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Show a short help message. .IP "\fB\-\-\fR" 4 .IX Item "--" End of options. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" The exit code can be consulted to determine errors, as follows: .IP "\fB0\fR \- Success." 4 .IX Item "0 - Success." .PD 0 .IP "\fB1\fR \- Error fetching OpenSearch Description \s-1URL.\s0" 4 .IX Item "1 - Error fetching OpenSearch Description URL." .IP "\fB2\fR \- Error parsing OpenSearch Description." 4 .IX Item "2 - Error parsing OpenSearch Description." .IP "\fB3\fR \- No matching search type found." 4 .IX Item "3 - No matching search type found." .IP "\fB4\fR \- Cannot find perl module WWW::OpenSearch." 4 .IX Item "4 - Cannot find perl module WWW::OpenSearch." .IP "\fB5\fR \- Unhandled error from WWW::OpenSearch." 4 .IX Item "5 - Unhandled error from WWW::OpenSearch." .PD .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Requires the module WWW::OpenSearch (Debian package libwww-opensearch-perl). .SH "BUGS" .IX Header "BUGS" Only supports \s-1GET\s0 queries. .PP Please report any bugs found to ianb@erislabs.net .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBopensearch\fR\|(1), \fBopensearch\-discover\fR\|(1), \fBsurfraw\fR\|(1), \&\fBWWW::OpenSearch\fR\|(3pm), .SH "AUTHOR" .IX Header "AUTHOR" Ian Beckwith .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2006 Ian Beckwith .PP Licensed under the same terms as surfraw.