mirror of
https://github.com/qbittorrent/qBittorrent.git
synced 2024-12-27 18:28:18 +03:00
|
|
||
|---|---|---|
| .. | ||
| qbittorrent-nox.1 | ||
| qbittorrent-nox.1.md | ||
| qbittorrent.1 | ||
| qbittorrent.1.md | ||
| README.md | ||
qBittorent man pages
Our man pages are written in Markdown format (.md) and we use Pandoc to convert them to roff (the man page format). Refer to Pandoc's Markdown for info on that specific format.
To build the man pages:
pandoc -s -f markdown -t man qbittorrent.1.md -o qbittorrent.1
pandoc -s -f markdown -t man qbittorrent-nox.1.md -o qbittorrent-nox.1
There is also an online converter you can use if you have trouble installing a
local one: link
You'll need to be careful when you copy the output to file as some headers will be missing.
Careful not to overwrite the existing leading headers or trim off the trailing headers.
Remember to commit Markdown files (*.md) and the generated man pages (*.1 files) after editing!