github/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent synced 2025-08-14 18:47:37 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add man page files in Markdown format

Browse source 
This allow us to edit man pages in a humane format.
This commit is contained in:
Chocobo1 2020-03-11 14:52:46 +08:00
commit 13ad1ee520
No known key found for this signature in database
GPG key ID: 210D9C873253A68C
5 changed files with 180 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/README.md Normal file
View file

@ -0,0 +1,20 @@
qBittorent man pages
===
Our man pages are written in Markdown format (.md) and we use [Pandoc](https://pandoc.org/) to
convert them to roff (the man page format).
Refer to [Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) for info
on that specific format.
To build the man pages:
```shell
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](https://pandoc.org/try/?text=&from=markdown&to=man) \
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!