# ManKier

> ManKier is a searchable, web-based collection of Linux man pages. Each page is split into sections, and every option and definition-list term has its own permalink. It also offers a free API for searching man pages, reading them section by section, and explaining whole shell commands.

Notes for agents:
- Cite urls returned by the API so users can verify the original text.

## API

- [API documentation](https://www.mankier.com/api): Full reference for the API, with request and response examples.
- [Search man pages](https://www.mankier.com/api#Search-Man-Pages): `GET /api/v3/mans/?q=<name>` returns up to 20 matches with name, section, description, and URL. Returns JSON. Example: GET https://www.mankier.com/api/v3/mans/?q=who
- [Man page details](https://www.mankier.com/api#Get-Man-Page-Details): `GET /api/v3/mans/<name>.<section>` returns the description, the section tree (with ids), and an `anchors` list of options/terms with permalinks. Supports: Markdown (default), JSON (with HTTP header Accept: application/json). Example: GET https://www.mankier.com/api/v3/mans/ls.1
- [Man page section](https://www.mankier.com/api#Get-a-Man-Page-Section): `GET /api/v3/mans/<name>.<section>/sections/<id>` returns one section (or subsection). Use ids from the details response, such as `Synopsis`, `Description`, or `Description-Exit_status`. Returns: Markdown. Example: GET https://www.mankier.com/api/v3/mans/ls.1/sections/Synopsis
- [Explain a command](https://www.mankier.com/api#Explain-a-Shell-Command): `GET /api/v3/explain/?q=<command>` returns plain text describing each flag in a full command line. Returns: plain text. Example: GET https://www.mankier.com/api/v3/explain/?cols=70&q=ls%20-lh

## Web pages

- [Home and search](https://www.mankier.com/): Search for a man page by name.
- Man page URL pattern: `https://www.mankier.com/<section>/<name>`, for example `https://www.mankier.com/1/ls`.
- Option permalink pattern: `https://www.mankier.com/<section>/<name>#<option>`, for example `https://www.mankier.com/1/ls#-a`. Use these to link directly to one flag's documentation.

## Manual sections

- 1 is user Commands
- 2 is System Calls
- 3 is Library Functions
- 4 is Special Files
- 5 is File Formats
- 6 is Games
- 7 is Miscellanea
- 8 is System Administration
- sections ending in p are POSIX Programmer's Manual pages, which describe portable standard behaviour rather than a specific implementation
- n is Tcl/Tk Keywords