explain config file in the README

master
Michele Guerini Rocco 2019-03-25 00:15:26 +01:00
parent a8423d4dc1
commit 7ee776b30f
Signed by: rnhmjoj
GPG Key ID: 91BE884FBA4B591A
1 changed files with 15 additions and 5 deletions

View File

@ -1,21 +1,32 @@
# Bisc
### A small tool that clears qutebrowser cookies
## Configuration
The bisc configuration file is `$XDG_CONFIG_HOME/bisc/bisc.conf`.
It allows to change the paths of the QtWebEngine/Chromium
directory and the whitelist file.
The default settings are:
```
whitelist-path = $(XDG_CONFIG_HOME)/qutebrowser/whitelists/cookies
webengine-path = $(XDG_DATA_HOME)/qutebrowser/webengine
```
## Usage
Create the file `$XDG_CONFIG_HOME/qutebrowser/whitelists/cookies`
and write the domains of the allowed cookies, one per line.
Create an empty whitelist file and write the domains of the
allowed cookies, one per line.
Eg.
```
.example.com
example.com
```
Run `bisc` to delete all non-whitelisted cookies from qutebrowser.
Run `bisc` to delete all non-whitelisted data from qutebrowser.
## License
Copyright (C) 2018 Michele Guerini Rocco
Copyright (C) 2019 Michele Guerini Rocco
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@ -29,4 +40,3 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.