Scroll to navigation

HOOGLE(1) General Commands Manual HOOGLE(1)

NAME

hoogle - A Haskell API search engine.

SYNOPSIS

hoogle EXPRESSION|COMMAND [OPTIONS]

DESCRIPTION

Hoogle is a Haskell API search engine which allows you to search Haskell libraries by either function name, or by approximate type signature. Example searches with EXPRESSION:



    map


    (a -> b) -> [a] -> [b]


    Ord a => [a] -> [a]


    Data.Map.insert

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.

This program also has some command for special usage.

Command reference:

Perform a search
Generate Hoogle databases
Start a Hoogle server
Replay a log file
Run the test suite

Common options:

-?, --help
Display help message
Print version information
Print just the version number
Loud verbosity
Quiet verbosity

Search command options:

Use colored output (requires ANSI terminal)
Get result as JSON
Get result as JSONL (JSON Lines)
Give URL's for each result
Give counter for each result
Give extended information about the first result
Name of database to use (use .hoo extension)
Maximum number of results to return (defaults to 10)
Number of times to repeat (for benchmarking)
Type signatures to compare against

Generate command options:

Download all files from the web
Name of database to use (use .hoo extension)
Allow insecure HTTPS connections
Maximum number of packages to index (defaults to all)
Index local packages and link to local haddock docs
Use local haddocks
Generate debug information

Server command options:

Port number
Name of database to use (use .hoo extension)
URL prefix to use
File to log requests to (defaults to stdout)
Allow following file:// links, restricts to 127.0.0.1. Set --host explicitly (including to '*' for any host) to override the localhost-only behavior.
Serve local haddocks from a specified directory
Display extra links
Default scope to start with
Set the URL linked to by the Hoogle logo.
Set the host to bind on (e.g., an ip address; '!4' for ipv4-only; '!6' for ipv6-only; default: '*' for any host).
Start an https server (use --cert and --key to specify paths to the .pem files)
Path to the certificate pem file (when running an https server)
Path to the key pem file (when running an https server)
Override data dirctory paths
Don't send CSP security headers

Replay command options:

Name of database to use (use .hoo extension)
Number of times to repeat (for benchmarking)
Default scope to start with

Test command options:

Run extra long tests
Disables the use of network tests
Name of database to use (use .hoo extension)

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).

SEE ALSO

haddock(1), update-hoogle(8)

October 30, 2016