about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMarq Schneider <queueRAM@gmail.com>2010-07-29 21:43:07 -0500
committerMarq Schneider <queueRAM@gmail.com>2010-07-29 21:43:07 -0500
commit76c49475cea16512cb319a5222f657254f487cc5 (patch)
treef286b33574d42e02615612df8ff6af2a82938353 /doc
parent79641da4f277dced59904f76f2dec4c5b4fdcb3c (diff)
downloadbtpd-76c49475cea16512cb319a5222f657254f487cc5.tar.gz
btpd-76c49475cea16512cb319a5222f657254f487cc5.zip
Added custom formats for list operation.
Added printf()-style '%' and '\' sequences for custom list formats.
Updated btcli manpage to reflect change and start -a.

Closes GH-8
Diffstat (limited to 'doc')
-rw-r--r--doc/btcli.150
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/btcli.1 b/doc/btcli.1
index 268d638..f1bed7e 100644
--- a/doc/btcli.1
+++ b/doc/btcli.1
@@ -56,6 +56,52 @@ List active torrents.
 .TP
 \fB\-i\fR
 List inactive torrents.
+.TP
+\fB\-f\fR format
+Specifies a custom format to use while displaying torrents.  The following is a
+list of the characters that can be used:
+.RS 8
+.PP
+\fB%n\fR - torrent name
+.br
+\fB%#\fR - torrent number
+.br
+\fB%h\fR - torrent hash
+.br
+\fB%d\fR - download directory
+.br
+\fB%t\fR - state
+.br
+\fB%P\fR - peer count
+.PP
+\fB%^\fR - upload rate
+.br
+\fB%v\fR - download rate
+.PP
+\fB%D\fR - downloaded bytes
+.br
+\fB%U\fR - uploaded bytes
+.br
+\fB%g\fR - bytes got
+.br
+\fB%u\fR - bytes uploaded
+.br
+\fB%s\fR - total size, (formatted: prints K, M, G)
+.br
+\fB%S\fR - total size, in bytes
+.PP
+\fB%A\fR - available pieces
+.br
+\fB%T\fR - total pieces
+.br
+\fB%H\fR - have pieces
+.PP
+\fB%p\fR - percent have (formatted)
+.br
+\fB%r\fR - ratio
+.PP
+\fB%%\fR - a percent symbol: '%'
+.RE
 .SH "STAT OPTIONS"
 .TP
 \fB\-i\fR
@@ -63,6 +109,10 @@ Display individual lines for each torrent.
 .TP
 \fB\-n\fR
 Display the name of each torrent.  Implies '-i'.
+.SH "START OPTIONS"
+.TP
+\fB\-a\fR
+Activate all non-active torrents.
 .SH "STOP OPTIONS"
 .TP
 \fB\-a\fR