configuration

1 files changed, 15 insertions, 0 deletions

diff --git a/videodb-check.pl b/videodb-check.pl
index daab658..674696a 100755
--- a/videodb-check.pl
+++ b/videodb-check.pl
@@ -82,6 +82,21 @@ one corresponding entry in the database.
 
 =back
 
+=head1 CONFIGURATION
+
+B<videodb-check> reads its database configuration from the file
+I<$HOME/.videodb.rc>. This file has to be the content of a Perl hash
+e.g.,
+
+  videodir  => catdir($HOME,'video'),
+  driver    => 'mysql',
+  database  => 'videodb',
+  hostname  => '127.0.0.1',
+  user      => 'username',
+  port      => 3306,
+  password  => '******',
+  videodata => "videodb_videodata",
+
 =head1 EXIT STATUS
 
 The exit status is 0 if your collection and database are sane, and 1