dragonfly/build/package/docs/dfcache/dfcache_doc.md

36 lines
1.4 KiB
Markdown

% DFCACHE(1) Version v2.0.9 | Frivolous "Dfcache" Documentation
# NAME
**dfcache doc** — generate documents
# SYNOPSIS
Generate markdown documents for cmd: dfcache.
```shell
dfcache doc [flags]
```
## OPTIONS
```
-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
--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 "dragonfly-dfcache")
-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
-h, --help help for doc
--path string destination dir of generated markdown documents (default "./")
```
# SEE ALSO
- [dfcache](dfcache.md) - the P2P cache client of dragonfly