doc/README.md

   1 qBittorent man pages
   2 ===
   3
   4 Our man pages are written in Markdown format (.md) and we use [Pandoc](https://pandoc.org/) to
   5 convert them to roff (the man page format).
   6 Refer to [Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) for info
   7 on that specific format.
   8
   9 To build the man pages:
  10 ```shell
  11 pandoc -s -f markdown -t man qbittorrent.1.md -o qbittorrent.1
  12 pandoc -s -f markdown -t man qbittorrent-nox.1.md -o qbittorrent-nox.1
  13 ```
  14
  15 There is also an online converter you can use if you have trouble installing a
  16 local one: [link](https://pandoc.org/try/?params=%7B%22to%22%3A%22man%22%2C%22from%22%3A%22markdown%22%2C%22standalone%22%3Atrue%7D) \
  17 You'll need to be careful when you copy the output to file as some headers will be missing.
  18 Careful not to overwrite the existing leading headers or trim off the trailing headers.
  19
  20 Remember to commit Markdown files (\*.md) and the generated man pages (\*.1 files) after editing!
  21
  22 ### Translation
  23
  24 To translate the man pages into a new language, create a new subdirectory here
  25 with the translated files and add it to the `manPageLanguages` list in
  26 [`dist/unix/CMakeLists.txt`](../dist/unix/CMakeLists.txt).