d4708
/
qBittorrent
mirror of https://github.com/d47081/qBittorrent.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Add man page files in Markdown format 

This allow us to edit man pages in a humane format.
adaptive-webui-19844
Chocobo1 5 years ago
parent
f80b7affd9
commit
13ad1ee520
No known key found for this signature in database
GPG Key ID: 210D9C873253A68C
5 changed files with 182 additions and 83 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 20
      doc/README.md
  2. 89
      doc/qbittorrent-nox.1
  3. 41
      doc/qbittorrent-nox.1.md
  4. 79
      doc/qbittorrent.1
  5. 36
      doc/qbittorrent.1.md

20
doc/README.md
Unescape View File

@ -0,0 +1,20 @@ @@ -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!

89
doc/qbittorrent-nox.1
Unescape View File

@ -1,44 +1,47 @@ @@ -1,44 +1,47 @@
.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>.
.TH "QBITTORRENT\-NOX" "1" "January 16th 2010" "Command line Bittorrent client written in C++ / Qt" ""
.SH "NAME"
qBittorrent\-nox \- a command line Bittorrent client written in C++ / Qt
.SH "SYNOPSIS"
\fBqbittorrent\-nox\fR [\-\-d|\-\-daemon] [\-\-webui-port=x] [TORRENT_FILE | URL]...
\fBqbittorrent\-nox\fR \-\-help
\fBqbittorrent\-nox\fR \-\-version
.PP
.SH "DESCRIPTION"
\fBqBittorrent-nox\fR is an advanced command-line Bittorrent client written in C++ / Qt
using the \fBlibtorrent-rasterbar\fR library by Arvid Norberg. qBittorrent\-nox aims
to be a good alternative to other command line bittorrent clients and provides features similar to popular graphical clients.
qBittorrent\-nox is fast, stable, light and it supports unicode.
It also comes with UPnP port forwarding / NAT-PMP, encryption (Vuze compatible),
FAST extension (mainline) and PeX support (utorrent compatible).
qBittorrent\-nox is meant to be controlled via its feature-rich Web UI which is accessible as a default on http://localhost:8080. The Web UI access is secured and the default account user name is "admin" with "adminadmin" as a password.
.SH "OPTIONS"
\fB--help\fR Prints the command line options.
\fB--version\fR Prints qbittorrent program version number.
\fB--webui-port=x\fR Changes Web UI port to x (default: 8080).
.SH "BUGS"
.\" Automatically generated by Pandoc 2.9.2
.\"
.TH "QBITTORRENT-NOX" "1" "January 16th 2010" "Command line Bittorrent client written in C++ / Qt" ""
.hy
.SH NAME
.PP
qBittorrent-nox - a command line Bittorrent client written in C++ / Qt
.SH SYNOPSIS
.PP
\f[B]qbittorrent-nox\f[R]
\f[C][--d|--daemon] [--webui-port=x] [TORRENT_FILE | URL]...\f[R]
.PP
\f[B]qbittorrent-nox\f[R] \f[C]--help\f[R]
.PP
\f[B]qbittorrent-nox\f[R] \f[C]--version\f[R]
.SH DESCRIPTION
.PP
\f[B]qBittorrent-nox\f[R] is an advanced command-line Bittorrent client
written in C++ / Qt using the \f[B]libtorrent-rasterbar\f[R] library by
Arvid Norberg.
qBittorrent-nox aims to be a good alternative to other command line
bittorrent clients and provides features similar to popular graphical
clients.
.PP
qBittorrent-nox is fast, stable, light and it supports unicode.
It also comes with UPnP port forwarding / NAT-PMP, encryption (Vuze
compatible), FAST extension (mainline) and PeX support (utorrent
compatible).
.PP
qBittorrent-nox is meant to be controlled via its feature-rich Web UI
which is accessible as a default on http://localhost:8080.
The Web UI access is secured and the default account user name is
\[lq]admin\[rq] with \[lq]adminadmin\[rq] as a password.
.SH OPTIONS
.PP
\f[B]\f[CB]--help\f[B]\f[R] Prints the command line options.
.PP
\f[B]\f[CB]--version\f[B]\f[R] Prints qbittorrent program version
number.
.PP
\f[B]\f[CB]--webui-port=x\f[B]\f[R] Changes Web UI port to x (default:
8080).
.SH BUGS
.PP
If you find a bug, please report it at http://bugs.qbittorrent.org
.SH "AUTHOR"
Christophe Dumez <chris@qbittorrent.org>
.SH AUTHORS
Christophe Dumez <chris@qbittorrent.org>.

41
doc/qbittorrent-nox.1.md
Unescape View File

@ -0,0 +1,41 @@ @@ -0,0 +1,41 @@
% QBITTORRENT-NOX(1) Command line Bittorrent client written in C++ / Qt
% Christophe Dumez <chris@qbittorrent.org>
% January 16th 2010
# NAME
qBittorrent-nox - a command line Bittorrent client written in C++ / Qt
# SYNOPSIS
**qbittorrent-nox** `[--d|--daemon] [--webui-port=x] [TORRENT_FILE | URL]...`
**qbittorrent-nox** `--help`
**qbittorrent-nox** `--version`
# DESCRIPTION
**qBittorrent-nox** is an advanced command-line Bittorrent client written in C++ / Qt
using the **libtorrent-rasterbar** library by Arvid Norberg.
qBittorrent-nox aims to be a good alternative to other command line bittorrent
clients and provides features similar to popular graphical clients.
qBittorrent-nox is fast, stable, light and it supports unicode. It also comes with
UPnP port forwarding / NAT-PMP, encryption (Vuze compatible), FAST extension (mainline)
and PeX support (utorrent compatible).
qBittorrent-nox is meant to be controlled via its feature-rich Web UI which is
accessible as a default on http://localhost:8080. The Web UI access is secured and
the default account user name is "admin" with "adminadmin" as a password.
# OPTIONS
**`--help`** Prints the command line options.
**`--version`** Prints qbittorrent program version number.
**`--webui-port=x`** Changes Web UI port to x (default: 8080).
# BUGS
If you find a bug, please report it at http://bugs.qbittorrent.org

79
doc/qbittorrent.1
Unescape View File

@ -1,42 +1,41 @@ @@ -1,42 +1,41 @@
.\" This manpage has been automatically generated by docbook2man
.\" from a DocBook document. This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>.
.\" Automatically generated by Pandoc 2.9.2
.\"
.TH "QBITTORRENT" "1" "January 16th 2010" "Bittorrent client written in C++ / Qt" ""
.SH "NAME"
qBittorrent \- a Bittorrent client written in C++ / Qt
.SH "SYNOPSIS"
\fBqbittorrent\fR [\-\-no-splash] [\-\-webui-port=x] [TORRENT_FILE | URL]...
\fBqbittorrent\fR \-\-help
\fBqbittorrent\fR \-\-version
.PP
.SH "DESCRIPTION"
\fBqBittorrent\fR is an advanced Bittorrent client written in C++ / Qt,
using the \fBlibtorrent-rasterbar\fR library by Arvid Norberg. qBittorrent is similar to uTorrent. qBittorrent
is fast, stable, light, it supports unicode and it provides a good integrated search engine.
It also comes with UPnP port forwarding / NAT-PMP, encryption (Vuze compatible),
FAST extension (mainline) and PeX support (utorrent compatible).
.SH "OPTIONS"
\fB--help\fR Prints the command line options.
\fB--version\fR Prints qbittorrent program version number.
\fB--no-splash\fR Disables splash screen on startup.
\fB--webui-port=x\fR Changes Web UI port to x (default: 8080).
.SH "BUGS"
.hy
.SH NAME
.PP
qBittorrent - a Bittorrent client written in C++ / Qt
.SH SYNOPSIS
.PP
\f[B]qbittorrent\f[R]
\f[C][--no-splash] [--webui-port=x] [TORRENT_FILE | URL]...\f[R]
.PP
\f[B]qbittorrent\f[R] \f[C]--help\f[R]
.PP
\f[B]qbittorrent\f[R] \f[C]--version\f[R]
.SH DESCRIPTION
.PP
\f[B]qBittorrent\f[R] is an advanced Bittorrent client written in C++ /
Qt, using the \f[B]libtorrent-rasterbar\f[R] library by Arvid Norberg.
qBittorrent is similar to uTorrent.
qBittorrent is fast, stable, light, it supports unicode and it provides
a good integrated search engine.
It also comes with UPnP port forwarding / NAT-PMP, encryption (Vuze
compatible), FAST extension (mainline) and PeX support (utorrent
compatible).
.SH OPTIONS
.PP
\f[B]\f[CB]--help\f[B]\f[R] Prints the command line options.
.PP
\f[B]\f[CB]--version\f[B]\f[R] Prints qbittorrent program version
number.
.PP
\f[B]\f[CB]--no-splash\f[B]\f[R] Disables splash screen on startup.
.PP
\f[B]\f[CB]--webui-port=x\f[B]\f[R] Changes Web UI port to x (default:
8080).
.SH BUGS
.PP
If you find a bug, please report it at http://bugs.qbittorrent.org
.SH "AUTHOR"
Christophe Dumez <chris@qbittorrent.org>
.SH AUTHORS
Christophe Dumez <chris@qbittorrent.org>.

36
doc/qbittorrent.1.md
Unescape View File

@ -0,0 +1,36 @@ @@ -0,0 +1,36 @@
% QBITTORRENT(1) Bittorrent client written in C++ / Qt
% Christophe Dumez <chris@qbittorrent.org>
% January 16th 2010
# NAME
qBittorrent - a Bittorrent client written in C++ / Qt
# SYNOPSIS
**qbittorrent** `[--no-splash] [--webui-port=x] [TORRENT_FILE | URL]...`
**qbittorrent** `--help`
**qbittorrent** `--version`
# DESCRIPTION
**qBittorrent** is an advanced Bittorrent client written in C++ / Qt,
using the **libtorrent-rasterbar** library by Arvid Norberg. qBittorrent is similar to uTorrent.
qBittorrent is fast, stable, light, it supports unicode and it provides a good integrated
search engine. It also comes with UPnP port forwarding / NAT-PMP, encryption (Vuze compatible),
FAST extension (mainline) and PeX support (utorrent compatible).
# OPTIONS
**`--help`** Prints the command line options.
**`--version`** Prints qbittorrent program version number.
**`--no-splash`** Disables splash screen on startup.
**`--webui-port=x`** Changes Web UI port to x (default: 8080).
# BUGS
If you find a bug, please report it at http://bugs.qbittorrent.org
Write Preview
Loading…
Cancel
Save