confini-dump.1 (3323B)
1 .TH confini-dump 1 Apply and output configurations 2 3 .SH NAME 4 confini-dump \- Apply and output configurations 5 6 .SH SYNOPSIS 7 .P 8 \fBconfini-dump\fP [ --ini ] [ --schema-dir ] [ \fIconfig_dir\fP ... ] 9 10 11 .SH DESCRIPTION 12 13 The \fBconfini-dump\fP tool uses the confini module to read configuration schemas and files, and adjust the configuration settings from environment the environment. Its main use is as a tool for debugging actual configuration settings for libraries or tools that use the confini library. 14 15 By default configuration settings are output as an environment variable assignments file (e.g. importable into a current bash shell using the \fBsource\fP command). By specifying \fB--ini\fP ini configuration files may be output instead. 16 17 If schemas are specified with \fB--schema-dir\fP or \fB--schema-module\fP, the contents of each \fIconfig_dir\fP must match the given schemas. See \fBCONFIGURATION SCHEMAS\fP below. 18 19 20 .SS OPTIONS 21 22 .TP 23 \fB--ini\fP 24 Output configuration as an ini file instead of environment variable key/value pairs. 25 26 .TP 27 \fB--doc\fP \fIdoc-key\fP 28 Only match configuration keys exactly matching \fIdoc_key\fP. May be specified multiple times to match multiple keys. If not set, all configuration settings will be output. 29 30 .TP 31 \fB--prefix\fP \fIprefix_string\fP 32 Prefix all output lines with the given string. No effect if \fB--ini\fP is set. 33 34 .TP 35 \fB--schema-dir\fP 36 Merge configurations from schema_dir into the current configuration schema. May be specified several times. Complements \fB--schema-module\fP. 37 38 .TP 39 \fB--schema-module\fP 40 Merge configurations from the filesystem directory the given python module resolves to. For example, if the module \fBfoo.bar\fP is in explicit include path \fB/tmp/pythonpath\fP (e.g. set by \fBPYTHONPATH\fP), the resulting path will be \fB/tmp/pythonpath/foo/bar/\fP. 41 42 .TP 43 \fB--skip-empty\fP 44 Omit configuration settings that have empty values after applying environment. 45 46 .TP 47 \fB-v\fP 48 Sends verbose logging output to stderr. If not set, only \fBWARNING\fP level logs will be sent. 49 50 .TP 51 \fB-z\fP 52 Remove all values in output. 53 54 55 .SH CONFIGURATION SCHEMAS 56 57 Configuration schemas define the configuration keys that are valid for a specific context. 58 59 If run without the \fB--schema-dir\fP and/or \fB--schema-module\fP options, no schema constraints will be applied. Or rather, the schema will be the merge of all the configurations read from all \fIconfig_dir\fP positional arguments. 60 61 If \fB--schema-dir\fP and/or \fB--schema-module\fP are defined, all configurations from the locations specified in these switches will be read. A schema is them created from the merged configurations. Thereafter, configurations from the \fIconfig_dir\fP positional arguments are read. If any of the configuration keys do not match the schema, an error will occur. 62 63 Regardless of schemas, two different configuration file locations may not define the same configuration sections. 64 65 66 .SH LICENSE 67 68 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International (CC BY-SA 4.0) license. 69 70 The source code of the tool this documentation describes is licensed under WTFPL 2.0. 71 72 73 .SH COPYRIGHT 74 75 Louis Holbrook <dev@holbrook.no> (https://holbrook.no) 76 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001 77 78 .SH SOURCE CODE 79 80 https://git.defalsify.org