about summary refs log tree commit diff
path: root/doc/btinfo.1
diff options
context:
space:
mode:
authorMarq Schneider <queueRAM@gmail.com>2010-07-17 22:18:20 -0500
committerMarq Schneider <queueRAM@gmail.com>2010-07-17 22:18:20 -0500
commit034ba1a5e4906d4f69dccea8d41108b5adbc780c (patch)
treead3cd88de58b92c52196be4758b3864c68942f03 /doc/btinfo.1
parentc94ed423cf2388480c4766c019b6853280ffcbbd (diff)
downloadbtpd-034ba1a5e4906d4f69dccea8d41108b5adbc780c.tar.gz
btpd-034ba1a5e4906d4f69dccea8d41108b5adbc780c.zip
Added man pages for btcli, btinfo, and btpd.
Lars Nooden originally put these together for OpenBSD.
They contain the same information from --help and the README.
Diffstat (limited to 'doc/btinfo.1')
-rw-r--r--doc/btinfo.147
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/btinfo.1 b/doc/btinfo.1
new file mode 100644
index 0000000..1e5a06b
--- /dev/null
+++ b/doc/btinfo.1
@@ -0,0 +1,47 @@
+.TH BTINFO "1" "2010\-07\-15" "BitTorrent Protocol Daemon 0.15" "User Commands"
+.\" disable hyphenation
+.nh
+.\" adjust text to left margin only
+.ad l
+.\" -----------------------------------------------------------------
+.\" MAIN CONTENT
+.\" -----------------------------------------------------------------
+.SH "NAME"
+btinfo \- BitTorrent Protocol Daemon information
+.SH "SYNOPSIS"
+.B btinfo
+\fIfile\fR
+.SH "EXAMPLE"
+List the torrent information for \fBosol\-0906\-x86.iso.torrent\fR
+.PP
+.nf
+.B $ btinfo /var/torrents/osol\-0906\-x86.iso.torrent
+Name: osol\-0906\-x86.iso
+Info hash: 58aca632a9f68427a8ac8f58cafa7a72ca067dba
+Tracker URLs: [ [ http://dlc.sun.com:6969/announce ] [ http://dlc.sun.com:16969/announce ] ]
+Number of pieces: 1354
+Piece size: 524288
+Total size: 709871616
+Number of files: 1
+Files:
+osol-0906-x86.iso (709871616)
+.fi
+.SH "TROUBLESHOOTING"
+If \fBbtpd\fR has shut down for some unknown reason, check the logfile for possible clues.
+.SH "BUGS"
+Known bugs are listed at \fIhttp://github.com/queueRAM/btpd/issues\fR
+.sp
+Before submitting a bug report, please verify that you are running the latest version of btpd.
+.SH "AUTHORS"
+.sp
+Current maintainers:
+.sp
+\- Marq Schneider <\fIqueueRAM@gmail.com\fR>
+.sp
+Past contributors:
+.sp
+\- Richard Nyberg <\fIbtpd@murmeldjur.se\fR> 
+.SH "SEE ALSO"
+.BR \fBbtpd\fR(1)
+.BR \fBbtcli\fR(1)
+