Add FILES section to the docs.

1 files changed, 41 insertions, 1 deletions

diff --git a/greypool b/greypool
index a34be32..980dc83 100755
--- a/greypool
+++ b/greypool
@@ -700,7 +700,7 @@ the usual way, and each non-comment line consists of a key, followed
 by one or more values. If there are multiple values, separate them
 with spaces.
 
-=head2 Config file keys
+=head2 Config File Keys
 
 =over 4
 
@@ -805,6 +805,46 @@ B<greypool> uses B<wget>(1) to talk to the repology.org API. This is a
 deliberate design choice, to avoid the long chain of perl dependencies
 required for libwww-perl.
 
+=head1 FILES
+
+=over 4
+
+=item B<~/.greypool/>
+
+The default config directory. Can be changed with the B<-C> /
+B<--config-dir> option. The rest of the files listed here are relative
+to this path.
+
+=item B<config>
+
+The config file, which at minimum sets the default email address and
+repository to check. See the B<CONFIG FILE> section, above.
+
+=item B<wgetrc>
+
+When B<greypool> runs B<wget>, it uses this file instead of the
+default B<~/.wgetrc>. If this file doesn't exist, B<greypool> will
+create it, with default settings for a custom user agent and with gzip
+compression enabled. Ideally, you shouldn't need to change anything
+here, but it's available if needed.
+
+=item B<cache/>
+
+Contains one cache directory per email address that's been checked.
+
+=item B<cache/>I<email-address>B</*.json>
+
+The cached JSON files, downloaded from the repology.org API. These
+are named B<1.json>, B<2.json>, etc.
+
+=item B<cache/>I<email-address>B</stamp>
+
+The date the B<*.json> files were downloaded. B<greypool> will only
+use the cached files if the current date matches this, otherwise
+they're considered expired and will be re-downloaded.
+
+=back
+
 =head1 AUTHOR
 
 B. Watson <urchlay@slackware.uk>, aka Urchlay on Libera IRC.