ManKier API

Search for man pages, get inforation about them, or explain whole commands.

Man Page Data

Search man pages starting with who:
https://www.mankier.com/api/mans/?q=who

Result (up to 20 entries):

{
  "q": "who",
  "truncated": false,
  "results": [
    {"text": "who(1)", "url": "//www.mankier.com/1/who"},
    {"text": "whoami(1)", "url": "//www.mankier.com/1/whoami"}
    ...
  ]
}
  

Get a description for a man page:
https://www.mankier.com/api/mans/who.1

Result:

{
  "name": "who",
  "num": "1",
  "html_description": "<p>Print information about users who are currently [...]",
  "section_name": "General commands",
  "url": "//www.mankier.com/1/who"
}
  

Get all the connections from and to a man page, and also any connections between its connections:
https://www.mankier.com/api/mesh/who.1

Result:

[
  {"f": "talk.1", "t": "who.1"},
  {"f": "write.1", "t": "who.1"},
  ...
]
  

Add callback parameter if you need it:
https://www.mankier.com/api/mans/who.1&callback=cb

Requests are served with this header:
Access-Control-Allow-Origin *

Explain a Shell Command

Explain tar -xf tarball.tar.gz, wrapping text at 70 chars (optional):
https://www.mankier.com/api/explain/?cols=70&q=tar -xf tarball.tar.gz

Result:

tar(1)
    GNU `tar' saves many files together into a single tape or disk
    archive, and can restore individual files from the archive.

    -x (-x, --extract, --get)
    extract files from an archive

    -f tarball.tar.gz (-f, --file=ARCHIVE)
    use archive file or device ARCHIVE