OS Manuals

/usr/bin/fy-join

Fully-featured YAML 1.2 and JSON parser and emitter C library, with the fy-tool CLI

From libfyaml 0.9.6-r1 (enterprise-packages), captured 2026-11-08 by running fy-join --help (exit 0). permalink

Usage: fy-join [options] [args]

General options:
  --help, -h                       : Display this help message
  --version, -v                    : Display libfyaml version
  --quiet, -q                      : Quiet operation (default false)
  --debug-level, -d <lvl>          : Set debug level (default 3)
  --color, -C <mode>               : Color output (on, off, auto) (default auto)
  --visible, -V                    : Make whitespace and linebreaks visible (default false)
  --dry-run                        : Do not parse/emit

Diagnostic options:
  --disable-diag <x>               : Disable diag error module <x>
  --enable-diag <x>                : Enable diag error module <x>
  --show-diag <x>                  : Show diag option <x> (source, position, type, module)
  --hide-diag <x>                  : Hide diag option <x> (source, position, type, module)

Parser options:
  --include, -I <path>             : Add directory to include path (default )
  --json, -j <mode>                : JSON input mode (no, force, auto) (default auto)
  --resolve, -r                    : Perform anchor and merge key resolution (default false)
  --yaml-1.1                       : Enable YAML 1.1
  --yaml-1.2                       : Enable YAML 1.2
  --yaml-1.3                       : Enable YAML 1.3
  --follow, -l                     : Follow aliases when using paths (default false)
  --sloppy-flow-indentation        : Enable sloppy indentation in flow mode (default false)
  --prefer-recursive               : Prefer recursive instead of iterative algorithms (default false)
  --ypath-aliases                  : Use YPATH aliases (default false)
  --allow-duplicate-keys           : Allow duplicate keys (default false)
  --collect-errors                 : Collect errors instead of outputting directly (default false)
  --disable-accel                  : Disable access accelerators (default false)
  --disable-buffering              : Disable buffering (use unix fd) (default false)
  --disable-mmap                   : Disable mmap usage
  --disable-depth-limit            : Disable depth limit (default false)

Emitter options:
  --indent, -i <indent>            : Set dump indent (default 2)
  --width, -w <width>              : Set dump width (inf for infinite) (default 80)
  --mode, -m <mode>                : Output mode (default original)
                                     (original, block, flow, flow-oneline, json, json-tp, json-oneline, dejson, pretty, flow-compact, json-compact)
  --sort, -s                       : Perform mapping key sort (default false)
  --comment, -c                    : Output comments (experimental) (default false)
  --strip-labels                   : Strip labels when emitting (default false)
  --strip-tags                     : Strip tags when emitting (default false)
  --strip-doc                      : Strip document headers and indicators (default false)
  --strip-empty-kv                 : Strip keys with empty values (default false)
  --null-output                    : Do not generate output
  --no-ending-newline              : Do not generate a final newline
  --preserve-flow-layout           : Preserve layout of single line flow collections
  --indented-seq-in-map            : Indent block sequences in block mappings

Input options:
  --file, -f <file>                : Use given file instead of <stdin>
                                     (a leading '>' in the string is treated as literal content)

Join options:
  --to, -T <path>                  : Join to path (default /)
  --from, -F <path>                : Join from path (default /)
  --trim, -t <path>                : Output given path (default /)

Examples:

    Parse and join two YAML files
  $ fy-join file1.yaml file2.yaml

    Parse and join two YAML maps
  $ fy-join ">foo: bar" ">baz: frooz"
  foo: bar
  baz: frooz

    Parse and join two YAML sequences
  $ fy-join -mblock ">[ foo ]" ">[ bar ]"
  - foo
  - bar
Options (77)
OptionDescriptionSource
--help, -hDisplay the built-in help message.help + man
--version, -vDisplay the libfyaml version.help + man
--quiet, -qSuppress informational and non-fatal diagnostic output.help + man
--debug-level, -d lvlSet the minimum diagnostic severity emitted by the library.help + man
--color, -C mode: Color output (on, off, auto) (default auto)help + man
--visible, -VMake spaces, tabs, and line breaks visible in text output.help + man
--dry-runParse the input but suppress normal output generation.help + man
--disable-diag xDisable diagnostic output for the named module.help + man
--enable-diag xEnable diagnostic output for the named module.help + man
--show-diag x: Show diag option <x> (source, position, type, module)help + man
--hide-diag x: Hide diag option <x> (source, position, type, module)help + man
--include, -I path: Add directory to include path (default )help + man
--json, -j mode: JSON input mode (no, force, auto) (default auto)help + man
--resolve, -r: Perform anchor and merge key resolution (default false)help + man
--yaml-1.1Force YAML 1.1 rules when the input does not declare a version.help + man
--yaml-1.2Force YAML 1.2 rules when the input does not declare a version.help + man
--yaml-1.3Force YAML 1.3 rules when the input does not declare a version.help + man
--follow, -lFollow aliases during path traversal and related path-based operations.help + man
--sloppy-flow-indentation: Enable sloppy indentation in flow mode (default false)help + man
--prefer-recursive: Prefer recursive instead of iterative algorithms (default false)help + man
--ypath-aliasesEnable alias processing for ypath evaluation.help + man
--allow-duplicate-keys: Allow duplicate keys (default false)help + man
--collect-errors: Collect errors instead of outputting directly (default false)help + man
--disable-accel: Disable access accelerators (default false)help + man
--disable-bufferingDisable stdio buffering and use direct file-descriptor reads.help + man
--disable-mmapDisable memory-mapped input.help + man
--disable-depth-limitDisable the normal nesting-depth limit.help + man
--indent, -i indentSet the output indentation width.help + man
--width, -w width: Set dump width (inf for infinite) (default 80)help + man
--mode, -m mode: Output mode (default original) (original, block, flow, flow-oneline, json, json-tp, json-oneline, dejson, pretty, flow-compact, json-compact)help + man
--sort, -s: Perform mapping key sort (default false)help + man
--comment, -c: Output comments (experimental) (default false)help + man
--strip-labelsStrip anchors and aliases from emitted output.help + man
--strip-tags: Strip tags when emitting (default false)help + man
--strip-doc: Strip document headers and indicators (default false)help + man
--strip-empty-kv: Strip keys with empty values (default false)help + man
--null-outputSuppress normal output generation.help + man
--no-ending-newlineDo not append a final trailing newline.help + man
--preserve-flow-layoutPreserve single-line flow collection layout when possible.help + man
--indented-seq-in-mapIndent block sequences that appear inside block mappings.help + man
--file, -f file: Use given file instead of <stdin> (a leading '>' in the string is treated as literal content)help + man
--to, -T path: Join to path (default /)help + man
--from, -F path: Join from path (default /)help + man
--trim, -t pathEmit only PATH from the joined result.help + man
--streamingUse streaming output mode. (in the manual page but not in --help)man
--no-streamingDisable streaming output mode. (in the manual page but not in --help)man
--recreatingRecreate streaming events instead of passing them through directly. (in the manual page but not in --help)man
--disable-flow-markersOmit testsuite flow markers. (in the manual page but not in --help)man
--disable-doc-markersOmit testsuite document markers. (in the manual page but not in --help)man
--disable-scalar-stylesOmit testsuite scalar-style markers. (in the manual page but not in --help)man
--document-event-streamBuild a document first and then generate the event stream from it. (in the manual page but not in --help)man
--tsv-formatEmit testsuite output in TSV format. (in the manual page but not in --help)man
--dump-pathexprDump the parsed path expression before evaluation. (in the manual page but not in --help)man
--noexecParse the expression but do not execute it. (in the manual page but not in --help)man
--dump-pathDump the path while composing a document. (in the manual page but not in --help)man
--b3sumEnable BLAKE3 hashing mode. (in the manual page but not in --help)man
--derive-key CONTEXTUse key-derivation mode with CONTEXT. (in the manual page but not in --help)man
--no-namesOmit file names from checksum output. (in the manual page but not in --help)man
--rawEmit raw digest bytes. (in the manual page but not in --help)man
--length NEmit only N output bytes, up to the BLAKE3 maximum. (in the manual page but not in --help)man
--checkVerify checksums read from input files. (in the manual page but not in --help)man
--keyedUse keyed hashing, reading the secret key from standard input. (in the manual page but not in --help)man
--backend BACKENDSelect the BLAKE3 backend implementation. (in the manual page but not in --help)man
--list-backendsList available BLAKE3 backends. (in the manual page but not in --help)man
--num-threads NSet the worker-thread count. (in the manual page but not in --help)man
--file-buffer NSet the per-file I/O buffer size. (in the manual page but not in --help)man
--mmap-min-chunk NSet the minimum chunk size used for memory-mapped hashing input. (in the manual page but not in --help)man
--mmap-max-chunk NSet the maximum chunk size used for memory-mapped hashing input. (in the manual page but not in --help)man
--dumpSelect dump mode. (in the manual page but not in --help)man
--testsuiteSelect testsuite mode. (in the manual page but not in --help)man
--filterSelect filter mode. (in the manual page but not in --help)man
--joinSelect join mode. (in the manual page but not in --help)man
--ypathSelect ypath query mode. (in the manual page but not in --help)man
--scan-dumpSelect the internal scan-dump mode. (in the manual page but not in --help)man
--parse-dumpSelect the internal parse-dump mode. (in the manual page but not in --help)man
--composeSelect composer-driver dump mode. (in the manual page but not in --help)man
--yaml-version-dumpPrint YAML version information. (in the manual page but not in --help)man
Examples (7) from the manual page, untested

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.