Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
D
diceware-debian
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
drebs
diceware-debian
Commits
8788e418
Commit
8788e418
authored
9 years ago
by
ulif
Browse files
Options
Downloads
Patches
Plain Diff
Add a configuration file description in docs.
Give config file docs an own page.
parent
52bc68c3
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/config.rst
+54
-0
54 additions, 0 deletions
docs/config.rst
docs/index.rst
+1
-0
1 addition, 0 deletions
docs/index.rst
with
55 additions
and
0 deletions
docs/config.rst
0 → 100644
+
54
−
0
View file @
8788e418
Configuration Files
===================
You can use configuration files to persistently override built-in
defaults and make your custom settings the default.
`diceware` configuration files follow simple ``.ini``-style and look
like this::
[diceware]
num = 7
caps = off
specials = 2
delimiter = MYDELIMITER
randomsource = system
wordlist = en_8k
The options names have to match long argument names, as output with
``--help``. The values set must meet the requirements valid for
commandline usage.
You can use all or only some (or none) of the above options. Please
note that other entries, providing unknown option names, are
ignored. That means that also typos might lead to ignored entries.
Please note, that all options must be set within a section
``[diceware]``.
Name and Path
-------------
Currently, we look for configuration files only in the calling users'
home directory. The file must be called::
.diceware.ini
(please note the leading dot). If such a file is missing, build-in
defaults apply.
Option Values
-------------
The option values set can be strings, integers, or boolean
values.
`diceware` accepts ``yes``, ``no``, ``1``, ``0``, ``true``, ``false``,
``on``, and ``off`` as boolean values.
Some options require their setting to be taken from a fixed set of
names/values, for instance the ``randomsource`` option.
If some value cannot be parsed, an exception is raised.
This diff is collapsed.
Click to expand it.
docs/index.rst
+
1
−
0
View file @
8788e418
...
...
@@ -16,6 +16,7 @@ Version: |version|
readme
randomsources
config
wordlists
api
changes
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment