dragonfly/build/package/docs/dfcache/dfcache.1

60 lines
2.4 KiB
Groff

.\" Automatically generated by Pandoc 2.13
.\"
.TH "DFCACHE" "1" "" "Version v2.0.9" "Frivolous \[lq]Dfcache\[rq] Documentation"
.hy
.SH NAME
.PP
\f[B]dfcache\f[R] \[em] the P2P cache client of dragonfly
.SH SYNOPSIS
.PP
dfcache is the cache client to of dragonfly that communicates with
dfdaemon and operates on files in P2P network, where the P2P network
acts as a cache system.
.PP
The difference between dfcache and dfget is that, dfget downloads file
from a given URL, the file might be on other peers in P2P network or a
seed peer, it\[cq]s the P2P network\[cq]s responsibility to download
file from source; but dfcache could only export or download a file that
has been imported or added into P2P network by other peer, it\[cq]s the
user\[cq]s responsibility to go back to source and add file into P2P
network.
.SS OPTIONS
.IP
.nf
\f[C]
-i, --cid string content or cache ID, e.g. sha256 digest of the content
--config string the path of configuration file with yaml extension name, default is /etc/dragonfly/dfcache.yaml, it can also be set by env var: DFCACHE_CONFIG
--console whether logger output records to the stdout
-h, --help help for dfcache
--jaeger string jaeger endpoint url, like: http://localhost:14250/api/traces
--logdir string Dfcache log directory
--pprof-port int listen port for pprof, 0 represents random port (default -1)
--service-name string name of the service for tracer (default \[dq]dragonfly-dfcache\[dq])
-t, --tag string different tags for the same cid will be recognized as different files in P2P network
--timeout duration Timeout for this cache operation, 0 is infinite
--verbose whether logger use debug level
--workhome string Dfcache working directory
\f[R]
.fi
.SH SEE ALSO
.IP \[bu] 2
dfcache completion - generate the autocompletion script for the
specified shell
.IP \[bu] 2
dfcache delete - delete file from P2P cache system
.IP \[bu] 2
dfcache doc - generate documents
.IP \[bu] 2
dfcache export - export file from P2P cache system
.IP \[bu] 2
dfcache import - import file into P2P cache system
.IP \[bu] 2
dfcache plugin - show plugin
.IP \[bu] 2
dfcache stat - stat checks if a file exists in P2P cache system
.IP \[bu] 2
dfcache version - show version
.SH BUGS
.PP
See GitHub Issues: <https://github.com/dragonflyoss/Dragonfly2/issues>