Version 1.14.
[pwmd.git] / doc / config.example
blob71d65309a5cb63c215868d3c631e7ccc9db9bca9
2 # Example PWMD configuration file. Edit and save to ~/.pwmd/config or
3 # specify with the -f command line option.
5 # The global section is for non-file related settings and file defaults.
6 [global]
8 # Location of the listening socket.
9 #socket_path=~/.pwmd/socket
11 # Socket permissions. This will override any umask setting.
12 #socket_perms=0600
14 # Where data files will be read and stored.
15 #data_directory=~/.pwmd/data
17 # If false, disable keeping backups for data files.
18 #backup=true
20 # Log file location.
21 #log_path=~/.pwmd/log
23 # Set to true to enable logging to log_path.
24 #enable_logging=false
26 # Set to true to enable logging to syslog.
27 #syslog=false
29 # File and key cache size. Must be in multiples of your systems PAGE_SIZE. The
30 # default below on a x86 Linux system is one page, or 59 files.
31 #cache_size=4096
33 # Set to false to call mlockall(2) after a client connects. Uses alot more
34 # memory but is also more secure. Most will probably find it overkill since
35 # the contents of all memory is cleared before being freed. Note that this
36 # doesn't affect the file cache which is always stored in RAM (if possible).
37 #disable_mlockall=true
39 # Disable the LIST and DUMP commands. When "true" and a client sends these
40 # commands an error GPG_ERR_NOT_IMPLEMENTED will be returned.
41 #disable_list_and_dump=false
43 # The number of encryption iterations for new files. This is the number of
44 # times the data will be encrypted. Setting this to a high value (10000 or
45 # more) will slow down dictionary attacks. Setting to -1 will disable
46 # encryption. Note that setting to 0 (the default) is really one encryption
47 # iteration. This is a known bug.
48 #iterations=0
50 # After the set number of encryption or decryption iterations have been
51 # processed, a status message with the keyword ENCRYPT or DECRYPT will be
52 # sent to the client. Set to 0 to disable.
53 #iteration_progress=0
55 # A list of filenames separated by commas to add to the file cache upon
56 # startup. You will be prompted for the key for each file if required. The
57 # files are looked for in data_directory.
58 #cache_push=somefile, anotherfile
60 # The number of seconds to keep a file in the cache. If -1, the file will be
61 # kept forever. If 0, then every OPEN and SAVE command will require a key.
62 #cache_timeout=-1
64 # Set to false to disable use of pinentry to retrieve keys.
65 #enable_pinentry=true
68 # Seconds until the pinentry dialog times out. Set to 0 to wait for input
69 # forever.
70 #pinentry_timeout=20
72 # The default compression level for data files from 1 to 9, 1 being the
73 # fastest but least compression and 9 being the slowest but best compression.
74 # To disable compression entirely, set to 0.
75 #compression_level=6
77 # The input and output buffer size when compressing and decompressing. This
78 # affects how often the COMPRESS and DECOMPRESS status messages are sent and
79 # also affects compression quality. Set to a higher value for larger files.
80 #zlib_bufsize=65536
82 # The maximum recursion depth when resolving elements that contain a "target"
83 # attribute. When this value is exceeded an error will be returned.
84 #recursion_depth=20
86 # Sends a KEEPALIVE status message every N seconds. Set to 0 to disable.
87 #keepalive=30
89 # The priority or nice value of the server process. The default is inherited
90 # from the parent process.
91 #priority=10
93 # END GLOBAL SETTINGS
95 # File specific settings are allowed by placing the filename in braces. Each
96 # file can have it's own configuration settings from those listed below.
97 #[somefile]
98 #cache_timeout=300
99 #iteration_progress=0
100 #key=password
101 #key_file=/path/to/file.key
102 #compression_level=0
103 #enable_pinentry=true
104 #pinentry_timeout=20
105 #backup=true