.de EX
.ne 5
.if n .sp 1
.if t .sp .5
.nf
.in +.5i
..
.de EE
.fi
.in -.5i
.if n .sp 1
.if t .sp .5
..
.TH HOOGLE 1 "October 30, 2016"
.SH NAME
hoogle \- A Haskell API search engine.
.SH SYNOPSIS
.B hoogle
.RI EXPRESSION|COMMAND
.RI [OPTIONS]
.SH DESCRIPTION
Hoogle is a Haskell API search engine which allows you to search Haskell
libraries by either function name, or by approximate type signature.
.EE
Example searches with EXPRESSION:
.EX

    map
    (a -> b) -> [a] -> [b]
    Ord a => [a] -> [a]
    Data.Map.insert

.EE
The Hoogle manual (http://www.haskell.org/haskellwiki/Hoogle) contains more
details, including further details on search queries, how to install Hoogle as
a command line application and how to integrate Hoogle with Firefox/Emacs/Vim
etc.
.PP
This program also has some command for special usage.
.SS "Command reference:"
.TP
\fBsearch\fR
Perform a search
.TP
\fBgenerate\fR
Generate Hoogle databases
.TP
\fBserver\fR
Start a Hoogle server
.TP
\fBreplay\fR
Replay a log file
.TP
\fBtest\fR
Run the test suite
.SS "Common options:"
.TP
\fB\-\fR?, \fB\-\-help\fR
Display help message
.TP
\fB\-V,\-\-version\fR
Print version information
.TP
\fB\-\-numeric\-version\fR
Print just the version number
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Loud verbosity
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Quiet verbosity
\# These flags exist but unless someone packages Frege for Debian I
\# think we can just skip even mentioning these.
\#.TP
\#\fB\-\-haskell\fR
\#Work with Haskell
\#.TP
\#\fB\-\-frege\fR
\#Work with Frege
.SS "Search command options:"
.TP
\fB\-\-color\fR, \fB\-\-colour\fR
Use colored output (requires ANSI terminal)
.TP
\fB\-\-json\fR
Get result as JSON
.TP
\fB\-\-jsonl\fR
Get result as JSONL (JSON Lines)
.TP
\fB\-l\fR, \fB\-\-link\fR
Give URL's for each result
.TP
\fB\-\-numbers\fR
Give counter for each result
.TP
\fB\-i\fR, \fB\-\-info\fR
Give extended information about the first result
.TP
\fB\-d\fR, \fB\-\-database\fR=\fIFILE\fR
Name of database to use (use .hoo extension)
.TP
\fB\-n\fR, \fB\-\-count\fR=\fIINT\fR
Maximum number of results to return (defaults to 10)
.TP
\fB\-r\fR, \fB\-\-repeat\fR=\fIINT\fR
Number of times to repeat (for benchmarking)
.TP
\fB\-\-compare\fR=\fIITEM\fR
Type signatures to compare against
.SS "Generate command options:"
.TP
\fB\-\-download\fR
Download all files from the web
.TP
\fB\-\-database\fR=\FIFILE\fR
Name of database to use (use .hoo extension)
.TP
\fB\-i\fR, \fB\-\-insecure\fR
Allow insecure HTTPS connections
.TP
\fB\-n\fR, \fB\-\-count\fR=\fIINT\fR
Maximum number of packages to index (defaults to all)
.TP
\fB\-l\fR, \fB\-\-local\fR[=\fIITEM\fR]
Index local packages and link to local haddock docs
.TP
\fB\-h\fR, \fB\-\-haddock\fR=\fIITEM\fR
Use local haddocks
.TP
\fB\-\-debug\fR
Generate debug information
.SS "Server command options:"
.TP
\fB\-p\fR, \fB\-\-port\fR=\fIINT\fR
Port number
.TP
\fB\-\-database\fR=\fIFILE\fR
Name of database to use (use .hoo extension)
.TP
\fB\-\-cdn\fR=\fIURL\fR
URL prefix to use
.TP
\fB\-\-logs\fR[=\fIFILE\fR]
File to log requests to (defaults to stdout)
.TP
\fB\-\-local\fR
Allow following file:// links, restricts to 127.0.0.1. Set --host
explicitly (including to '*' for any host) to override the
localhost-only behavior.
.TP
\fB\-\-haddock\fR=\fIITEM\fR
Serve local haddocks from a specified directory
.TP
\fB\-\-links\fR
Display extra links
.TP
\fB\-s\fR, \fB\-\-scope\fR=\fIITEM\fR
Default scope to start with
.TP
\fB\-\-home\fR=\fIURL\fR
Set the URL linked to by the Hoogle logo.
.TP
\fB\-\-host\fR=\fIITEM\fR
Set the host to bind on (e.g., an ip address; '!4' for ipv4-only; '!6'
for ipv6-only; default: '*' for any host).
.TP
\fB\-\-https\fR
Start an https server (use \fB--cert\fR and \fB--key\fR to specify
paths to the .pem files)
.TP
\fB\-\-cert\fR=\fIFILE\fR
Path to the certificate pem file (when running an https server)
.TP
\fB\-k\fR, \fB\-\-key\fR
Path to the key pem file (when running an https server)
.TP
\fB\-\-datadir\fR=\fIITEM\fR
Override data dirctory paths
.TP
\fB\-n\fR, \fB\-\-no-security-headers\fR
Don't send CSP security headers
.SS "Replay command options:"
.TP
\fB\-\-database\fR=\fIFILE\fR
Name of database to use (use .hoo extension)
.TP
\fB\-r\fR, \fB\-\-repeat\fR=\fIINT\fR
Number of times to repeat (for benchmarking)
.TP
\fB\-s\fR, \fB\-\-scope\fR=\fIITEM\fR
Default scope to start with
.SS "Test command options:"
.TP
\fB\-\-deep\fR
Run extra long tests
.TP
\fB\-\-disable-network-tests\fR
Disables the use of network tests
.TP
\fB\-\-database\fR=\fIFILE\fR
Name of database to use (use .hoo extension)
.SH AUTHOR
The text for this page was constructed from the Hoogle search engine's web page
and written by Erik de Castro Lopo <erikd@mega-nerd.com> and Kiwamu Okabe
<kiwamu@debian.or.jp>, for the Debian GNU/Linux system (but may be used by
others).
.SH "SEE ALSO"
.LP
haddock(1), update-hoogle(8)