mirrors/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent.git synced 2024-11-22 17:26:21 +03:00
Code Issues Projects Releases Packages Wiki Activity
qBittorrent/doc
History
Chocobo1 bbd5ed1142
Switch URLs to https 
PR #18876.
2023-04-23 15:09:58 +08:00
..
qbittorrent-nox.1 Switch URLs to https 2023-04-23 15:09:58 +08:00
qbittorrent-nox.1.md Switch URLs to https 2023-04-23 15:09:58 +08:00
qbittorrent.1 Switch URLs to https 2023-04-23 15:09:58 +08:00
qbittorrent.1.md Switch URLs to https 2023-04-23 15:09:58 +08:00
README.md Add man page files in Markdown format 2020-03-12 13:12:33 +08:00

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!