Configuration¶
All mdedup options can be set with a configuration file.
Location¶
Location depends on OS (see click-extra doc):
Platform |
Folder |
|---|---|
macOS |
|
Unix |
|
Windows |
|
TOML sample¶
# My default configuration file.
[mdedup]
verbosity = "DEBUG"
strategy = "discard-older"
action = "delete-discarded"
Troubleshooting¶
You can easily debug the way mdedup source its configuration with the --show-params:
$ mdedup --table-format vertical --show-params
***************************[ 1. row ]***************************
ID | mdedup.action
Spec. | -a, --action [copy-selected|copy-discarded|move-selected|move-discarded|delete-selected|delete-discarded]
Class | click_extra.parameters.Option
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_ACTION
Default | 'copy-selected'
Value | 'copy-selected'
Source | DEFAULT
***************************[ 2. row ]***************************
ID | mdedup.color
Spec. | --color, --ansi / --no-color, --no-ansi
Class | click_extra.colorize.ColorOption
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✓
Env. vars. | MDEDUP_COLOR
Default | True
Value | True
Source | DEFAULT
***************************[ 3. row ]***************************
ID | mdedup.config
Spec. | --config CONFIG_PATH
Class | click_extra.config.ConfigOption
Param type | click.types.UnprocessedParamType
Python type | str
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✘
Env. vars. | MDEDUP_CONFIG
Default | '/home/runner/.config/mdedup/*.toml|*.yaml|*.yml|*.json|*.ini'
Value | '/home/runner/.config/mdedup/*.toml|*.yaml|*.yml|*.json|*.ini'
Source | DEFAULT
***************************[ 4. row ]***************************
ID | mdedup.config
Spec. | --no-config
Class | click_extra.config.NoConfigOption
Param type | click.types.UnprocessedParamType
Python type | str
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✘
Env. vars. | MDEDUP_CONFIG
Default | Sentinel.UNSET
Value | Sentinel.UNSET
Source | DEFAULT
***************************[ 5. row ]***************************
ID | mdedup.content_threshold
Spec. | -C, --content-threshold BYTES
Class | click_extra.parameters.Option
Param type | click.types.IntRange
Python type | int
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_CONTENT_THRESHOLD
Default | 768
Value | 768
Source | DEFAULT
***************************[ 6. row ]***************************
ID | mdedup.dry_run
Spec. | -n, --dry-run
Class | click_extra.parameters.Option
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_DRY_RUN
Default | False
Value | False
Source | DEFAULT
***************************[ 7. row ]***************************
ID | mdedup.export
Spec. | -E, --export MAIL_BOX_PATH
Class | click_extra.parameters.Option
Param type | click.types.Path
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_EXPORT
Default | Sentinel.UNSET
Value | Sentinel.UNSET
Source | DEFAULT
***************************[ 8. row ]***************************
ID | mdedup.export_append
Spec. | --export-append
Class | click_extra.parameters.Option
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_EXPORT_APPEND
Default | False
Value | False
Source | DEFAULT
***************************[ 9. row ]***************************
ID | mdedup.export_format
Spec. | -e, --export-format [maildir|mbox|mh|babyl|mmdf]
Class | click_extra.parameters.Option
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_EXPORT_FORMAT
Default | 'mbox'
Value | 'mbox'
Source | DEFAULT
***************************[ 10. row ]***************************
ID | mdedup.force_unlock
Spec. | -u, --force-unlock
Class | click_extra.parameters.Option
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_FORCE_UNLOCK
Default | False
Value | False
Source | DEFAULT
***************************[ 11. row ]***************************
ID | mdedup.hash_body
Spec. | -b, --hash-body [skip|raw|normalized]
Class | click_extra.parameters.Option
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_HASH_BODY
Default | 'skip'
Value | 'skip'
Source | DEFAULT
***************************[ 12. row ]***************************
ID | mdedup.hash_header
Spec. | -h, --hash-header Header-ID
Class | click_extra.parameters.Option
Param type | click.types.StringParamType
Python type | list
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_HASH_HEADER
Default | ('Date', 'From', 'To', 'Subject', 'MIME-Version', 'Content-Type', 'Content-Disposition', 'User-Agent', 'X-Priority', 'Message-ID')
Value | ('Date', 'From', 'To', 'Subject', 'MIME-Version', 'Content-Type', 'Content-Disposition', 'User-Agent', 'X-Priority', 'Message-ID')
Source | DEFAULT
***************************[ 13. row ]***************************
ID | mdedup.hash_only
Spec. | -H, --hash-only
Class | click_extra.parameters.Option
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_HASH_ONLY
Default | False
Value | False
Source | DEFAULT
***************************[ 14. row ]***************************
ID | mdedup.help
Spec. | --help
Class | click.core.Option
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✘
Env. vars. | MDEDUP_HELP
Default | False
Value | False
Source | DEFAULT
***************************[ 15. row ]***************************
ID | mdedup.input_format
Spec. | -i, --input-format [maildir|mbox|mh|babyl|mmdf]
Class | click_extra.parameters.Option
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_INPUT_FORMAT
Default | Sentinel.UNSET
Value | Sentinel.UNSET
Source | DEFAULT
***************************[ 16. row ]***************************
ID | mdedup.mail_sources
Spec. |
Class | click_extra.parameters.Argument
Param type | click.types.Path
Python type | list
Hidden |
Exposed | ✓
Allowed in conf? | ✓
Env. vars. |
Default | Sentinel.UNSET
Value | Sentinel.UNSET
Source | DEFAULT
***************************[ 17. row ]***************************
ID | mdedup.minimal_headers
Spec. | -m, --minimal-headers INTEGER
Class | click_extra.parameters.Option
Param type | click.types.IntRange
Python type | int
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_MINIMAL_HEADERS
Default | 4
Value | 4
Source | DEFAULT
***************************[ 18. row ]***************************
ID | mdedup.regexp
Spec. | -r, --regexp REGEXP
Class | click_extra.parameters.Option
Param type | click.types.StringParamType
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_REGEXP
Default | Sentinel.UNSET
Value | Sentinel.UNSET
Source | DEFAULT
***************************[ 19. row ]***************************
ID | mdedup.show_diff
Spec. | -d, --show-diff
Class | click_extra.parameters.Option
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_SHOW_DIFF
Default | False
Value | False
Source | DEFAULT
***************************[ 20. row ]***************************
ID | mdedup.show_params
Spec. | --show-params
Class | click_extra.parameters.ShowParamsOption
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✘
Env. vars. | MDEDUP_SHOW_PARAMS
Default | False
Value | True
Source | COMMANDLINE
***************************[ 21. row ]***************************
ID | mdedup.size_threshold
Spec. | -S, --size-threshold BYTES
Class | click_extra.parameters.Option
Param type | click.types.IntRange
Python type | int
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_SIZE_THRESHOLD
Default | 512
Value | 512
Source | DEFAULT
***************************[ 22. row ]***************************
ID | mdedup.strategy
Spec. | -s, --strategy [select-older|select-oldest|select-newer|select-newest|discard-newest|discard-newer|discard-oldest|discard-older|select-smaller|select-smallest|select-bigger|select-biggest|discard-biggest|discard-bigger|discard-smallest|discard-smaller|select-matching-path|select-non-matching-path|discard-non-matching-path|discard-matching-path|select-one|select-all-but-one|discard-all-but-one|discard-one]
Class | click_extra.parameters.Option
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_STRATEGY
Default | Sentinel.UNSET
Value | Sentinel.UNSET
Source | DEFAULT
***************************[ 23. row ]***************************
ID | mdedup.table_format
Spec. | --table-format [asciidoc|csv|csv-excel|csv-excel-tab|csv-unix|double-grid|double-outline|fancy-grid|fancy-outline|github|grid|heavy-grid|heavy-outline|html|jira|latex|latex-booktabs|latex-longtable|latex-raw|mediawiki|mixed-grid|mixed-outline|moinmoin|orgtbl|outline|pipe|plain|presto|pretty|psql|rounded-grid|rounded-outline|rst|simple|simple-grid|simple-outline|textile|tsv|unsafehtml|vertical|youtrack]
Class | click_extra.table.TableFormatOption
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✓
Env. vars. | MDEDUP_TABLE_FORMAT
Default | 'rounded-outline'
Value | 'vertical'
Source | COMMANDLINE
***************************[ 24. row ]***************************
ID | mdedup.time
Spec. | --time / --no-time
Class | click_extra.timer.TimerOption
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✓
Env. vars. | MDEDUP_TIME
Default | False
Value | False
Source | DEFAULT
***************************[ 25. row ]***************************
ID | mdedup.time_source
Spec. | -t, --time-source [date-header|ctime]
Class | click_extra.parameters.Option
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✓
Allowed in conf? | ✓
Env. vars. | MDEDUP_TIME_SOURCE
Default | 'date-header'
Value | 'date-header'
Source | DEFAULT
***************************[ 26. row ]***************************
ID | mdedup.verbose
Spec. | -v, --verbose
Class | click_extra.logging.VerboseOption
Param type | click.types.IntRange
Python type | int
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✓
Env. vars. | MDEDUP_VERBOSE
Default | 0
Value | 0
Source | DEFAULT
***************************[ 27. row ]***************************
ID | mdedup.verbosity
Spec. | --verbosity LEVEL
Class | click_extra.logging.VerbosityOption
Param type | click_extra.types.EnumChoice
Python type | str
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✓
Env. vars. | MDEDUP_VERBOSITY
Default | 'INFO'
Value | 'INFO'
Source | DEFAULT_MAP
***************************[ 28. row ]***************************
ID | mdedup.version
Spec. | --version
Class | click_extra.version.ExtraVersionOption
Param type | click.types.BoolParamType
Python type | bool
Hidden | ✘
Exposed | ✘
Allowed in conf? | ✘
Env. vars. | MDEDUP_VERSION
Default | False
Value | False
Source | DEFAULT