138 lines
3.9 KiB
Groff
138 lines
3.9 KiB
Groff
.\" Automatically generated by Pandoc 2.13
|
|
.\"
|
|
.TH "DFGET" "1" "" "Version v0.1.0-beta" "Frivolous \[lq]Dfget\[rq] Documentation"
|
|
.hy
|
|
.SH NAME
|
|
.PP
|
|
\f[B]dfget\f[R] \[em] client of Dragonfly used to download and upload
|
|
files
|
|
.SH SYNOPSIS
|
|
.PP
|
|
dfget is the client of Dragonfly which takes a role of peer in a P2P
|
|
network.
|
|
When user triggers a file downloading task, dfget will download the
|
|
pieces of file from other peers.
|
|
Meanwhile, it will act as an uploader to support other peers to download
|
|
pieces from it if it owns them.
|
|
In addition, dfget has the abilities to provide more advanced
|
|
functionality, such as network bandwidth limit, transmission encryption
|
|
and so on.
|
|
.SS Options
|
|
.TP
|
|
\[en]alivetime
|
|
alive duration for which uploader keeps no accessing by any uploading
|
|
requests, after this period uploader will automatically exit (default
|
|
5m0s)
|
|
.TP
|
|
\[en]cacerts
|
|
the cacert file which is used to verify remote server when supernode
|
|
interact with the source.
|
|
.TP
|
|
\[en]callsystem
|
|
the name of dfget caller which is for debugging.
|
|
Once set, it will be passed to all components around the request to make
|
|
debugging easy
|
|
.TP
|
|
\[en]clientqueue
|
|
specify the size of client queue which controls the number of pieces
|
|
that can be processed simultaneously
|
|
.TP
|
|
\[en]console
|
|
show log on console, it\[cq]s conflict with `\[en]showbar'
|
|
.TP
|
|
\[en]daemon-pid
|
|
the daemon pid (default \[lq]/tmp/dfdaemon.pid\[rq])
|
|
.TP
|
|
\[en]daemon-sock
|
|
the unix domain socket address for grpc with daemon (default
|
|
\[lq]/tmp/dfdamon.sock\[rq])
|
|
.TP
|
|
\[en]dfdaemon
|
|
identify whether the request is from dfdaemon
|
|
.TP
|
|
\[en]expiretime
|
|
caching duration for which cached file keeps no accessed by any process,
|
|
after this period cache file will be deleted (default 3m0s)
|
|
.TP
|
|
-f, \[en]filter
|
|
filter some query params of URL, use char `&' to separate different
|
|
params
|
|
.TP
|
|
\[en]header
|
|
http header
|
|
.TP
|
|
-h, \[en]help
|
|
help for dfget
|
|
.TP
|
|
\[en]home
|
|
the work home directory of dfget (default
|
|
\[lq]/Users/jim/.dragonfly/dfdaemon/\[rq])
|
|
.TP
|
|
-i, \[en]identifier
|
|
the usage of identifier is making different downloading tasks generate
|
|
different downloading task IDs even if they have the same URLs.
|
|
conflict with \[en]md5.
|
|
.TP
|
|
\[en]insecure
|
|
identify whether supernode should skip secure verify when interact with
|
|
the source.
|
|
.TP
|
|
\[en]ip
|
|
IP address that server will listen on (default \[lq]0.0.0.0\[rq])
|
|
.TP
|
|
-m, \[en]md5
|
|
md5 value input from user for the requested downloading file to enhance
|
|
security
|
|
.TP
|
|
\[en]more-daemon-options
|
|
more options passed to daemon by command line, please confirm your
|
|
options with \[lq]dfget daemon \[en]help\[rq]
|
|
.TP
|
|
-n, \[en]node
|
|
deprecated, please use schedulers instead.
|
|
specify the addresses(host:port=weight) of supernodes where the host is
|
|
necessary, the port(default: 8002) and the weight(default:1) are
|
|
optional.
|
|
And the type of weight must be integer
|
|
.TP
|
|
\[en]notbacksource
|
|
disable back source downloading for requested file when p2p fails to
|
|
download it
|
|
.TP
|
|
-o, \[en]output
|
|
destination path which is used to store the requested downloading file.
|
|
It must contain detailed directory and specific filename, for example,
|
|
`/tmp/file.mp4'
|
|
.TP
|
|
-p, \[en]pattern
|
|
download pattern, must be p2p/cdn/source, cdn and source do not support
|
|
flag \[en]totallimit (default \[lq]p2p\[rq])
|
|
.TP
|
|
\[en]port
|
|
port number that server will listen on (default 65002)
|
|
.TP
|
|
\[en]schedulers
|
|
the scheduler addresses
|
|
.TP
|
|
-b, \[en]showbar
|
|
show progress bar, it is conflict with `\[en]console'
|
|
.TP
|
|
-e, \[en]timeout
|
|
timeout set for file downloading task.
|
|
If dfget has not finished downloading all pieces of file before
|
|
\[en]timeout, the dfget will throw an error and exit
|
|
.TP
|
|
\[en]totallimit
|
|
network bandwidth rate limit for the whole host, in format of
|
|
G(B)/g/M(B)/m/K(B)/k/B, pure number will also be parsed as Byte (default
|
|
104857600.000000)
|
|
.TP
|
|
-u, \[en]url
|
|
URL of user requested downloading file(only HTTP/HTTPs supported)
|
|
.TP
|
|
\[en]verbose
|
|
enable verbose mode, all debug log will be display
|
|
.SH BUGS
|
|
.PP
|
|
See GitHub Issues: <https://github.com/dragonflyoss/Dragonfly2/issues>
|