Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

btpc config explain create

Explain effective create values and provenance

Parent: btpc config explain

See Configuration and global flags and Exit codes and streams.

Synopsis

Usage: btpc config explain create [OPTIONS] [INPUTS]...

Arguments

ArgumentDescription
<INPUTS>Payload files or directories

Options

OptionDescription
--batch, <BATCH>Versioned TOML batch manifest
--mode, <MODE>Torrent protocol representation Values: v1, v2, hybrid.
-o, --output, <OUTPUT>Destination .torrent path (defaults beside the payload)
--output-dir, <OUTPUT_DIR>Write batch outputs beneath this directory
--jobs, <JOBS>Maximum concurrent batch creation jobs Default: 1.
--fail-fastStop scheduling batch jobs after the first failure Default: false.
-f, --forceReplace an existing destination Default: false.
--durableSync the destination directory after atomic publication where supported Default: false.
--preset, <PRESETS>Apply a named creation preset; may be repeated
--piece-length, <PIECE_LENGTH>Explicit piece length in bytes
--target-pieces, <TARGET_PIECES>Target approximate number of pieces for automatic selection
--max-piece-length, <MAX_PIECE_LENGTH>Cap target-based automatic piece length
-a, --tracker, <TRACKERS>Add a tracker as its own tier; may be repeated
--clear-trackersClear configured and preset trackers before CLI additions Default: false.
--tracker-tier, <TRACKER_TIER>Add one comma-separated tracker tier; may be repeated
--tracker-alias, <TRACKER_ALIASES>Add a configured tracker alias; may be repeated
--tracker-group, <TRACKER_GROUPS>Add a configured tracker group; may be repeated
--web-seed, <WEB_SEEDS>Add a web seed URL; may be repeated
--clear-web-seedsClear configured and preset web seeds before CLI additions Default: false.
--node, <NODES>Add a DHT node as HOST:PORT; may be repeated
--privateSet the private flag Default: false.
--publicSet the private flag to false Default: false.
--source, <SOURCE>Set the source field
--clear-sourceRemove configured or preset source metadata Default: false.
--comment, <COMMENT>Set the top-level comment
--clear-commentRemove configured or preset comment metadata Default: false.
--created-by, <CREATED_BY>Set the creator string
--no-created-by, --clear-created-byOmit the creator string instead of using the versioned default Default: false.
--creation-date, <CREATION_DATE>Include an explicit Unix creation timestamp
--entropy, <ENTROPY>Set deterministic, random, or omitted entropy policy
--name, <NAME>Override the torrent root name
--exclude-hiddenExclude dot-prefixed files and directories Default: false.
--symlinks, <SYMLINKS>Symbolic-link policy Values: reject, skip, follow.
--special-files, <SPECIAL_FILES>Special-file policy Values: reject, skip.
--exclude-empty-filesExclude zero-length files Default: false.
--reject-empty-directoriesReject empty directories instead of ignoring them Default: false.
--include, <INCLUDES>Include only paths matching this glob; may be repeated
--clear-includesClear configured and preset include patterns before CLI additions Default: false.
--exclude, <EXCLUDES>Exclude paths matching this glob; may be repeated
--clear-excludesClear configured and preset exclude patterns before CLI additions Default: false.
--threads, <THREADS>v1 hashing threads; 0 selects a conservative automatic count, 1 is sequential
--dry-runPlan creation without hashing or writing metainfo Default: false.
--print, <PRINT>Print selected result fields; may be repeated Values: path, info-hash-v1, info-hash-v2, magnet.
--jsonEmit a versioned JSON result to stdout Default: false.
--prettyUse the expanded human completion renderer Default: false.
-h, --helpPrint help

Global options

OptionDescription
--config, <PATH>Use this configuration file when configuration loading is enabled
--no-configDisable implicit and environment-selected configuration Default: false.
--color, <COLOR>Control colored terminal output Values: auto, always, never.
-v, --verboseIncrease diagnostic verbosity; may be repeated Default: 0.
-q, --quietSuppress human summaries, warnings, and progress Default: false.

Example

$ btpc config explain create --help