freshened up docs

diff --git a/deptrack/doc/.cvsignore b/deptrack/doc/.cvsignore
new file mode 100644 (file)
index 0000000..503ff1c
--- /dev/null
+++ b/deptrack/doc/.cvsignore
@@ -0,0 +1,3 @@
+deptrack.1
+Makefile
+Makefile.in

diff --git a/deptrack/doc/Makefile.am b/deptrack/doc/Makefile.am
new file mode 100644 (file)
index 0000000..92b252b
--- /dev/null
+++ b/deptrack/doc/Makefile.am
@@ -0,0 +1,8 @@
+# $Id$
+
+SUBDIRS =
+
+man_MANS = deptrack.1
+
+EXTRA_DIST = deptrackrc deptrack.sql
+

diff --git a/deptrack/doc/deptrack.1.in b/deptrack/doc/deptrack.1.in
new file mode 100644 (file)
index 0000000..a63b8c8
--- /dev/null
+++ b/deptrack/doc/deptrack.1.in
@@ -0,0 +1,27 @@
+.TH DEPTRACK 1 "1 February 2003"  "Version @VERSION@" "PHP dependency tracker"
+.SH NAME
+deptrack \- a PHP dependency tracker
+.SH SYNOPSIS
+.B deptrack
+[\fB-h\fR]
+.br
+.B deptrack
+[\fB-d\fR] [\fB-f\fR \fIconfig\fR] \fIroot\fR
+.SH DESCRIPTION
+\fBdeptrack\fR is a script that allows you to analyse the dependencies of a set
+of PHP files and store the results in a MySQL database. Prior to running \fBdeptrack\fR you should have created the tables to store the dependencies and have a configured \fI~/.deptrackrc\fR file.
+.SH OPTIONS
+.IP "\fB-h\fR"
+Display syntax help.
+.IP "\fB-f\fR"
+Use \fIconfig\fR instead of ~/.deptrackrc
+.IP "\fB-d\fR"
+Enable debug mode.
+.SH COPYRIGHT
+Copyright \(co  2002-2003 Jeremy Lainé
+.PP
+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 the Free
+Software Foundation; either version 2 of the License, or (at your option)
+any later version.
+

diff --git a/deptrack/doc/deptrack.sql b/deptrack/doc/deptrack.sql
new file mode 100644 (file)
index 0000000..4da6f22
--- /dev/null
+++ b/deptrack/doc/deptrack.sql
@@ -0,0 +1,39 @@
+#
+# Table structure for table `dep`
+#
+
+CREATE TABLE dep (
+  id int(8) NOT NULL auto_increment,
+  dir int(6) NOT NULL default '0',
+  page int(6) NOT NULL default '0',
+  dep int(6) NOT NULL default '0',
+  type enum('include','image','link') NOT NULL default 'include',
+  PRIMARY KEY  (id)
+) TYPE=MyISAM;
+# --------------------------------------------------------
+
+#
+# Table structure for table `dir`
+#
+
+CREATE TABLE dir (
+  id int(6) NOT NULL auto_increment,
+  path varchar(255) NOT NULL default '',
+  PRIMARY KEY  (id),
+  UNIQUE KEY path (path)
+) TYPE=MyISAM;
+# --------------------------------------------------------
+
+#
+# Table structure for table `file`
+#
+
+CREATE TABLE file (
+  id int(6) NOT NULL auto_increment,
+  path varchar(255) NOT NULL default '',
+  type enum('dead','page','include','image') NOT NULL default 'dead',
+  dir int(6) NOT NULL default '0',
+  PRIMARY KEY  (id),
+  UNIQUE KEY path (path)
+) TYPE=MyISAM;
+

diff --git a/deptrack/doc/deptrackrc b/deptrack/doc/deptrackrc
new file mode 100644 (file)
index 0000000..6aae378
--- /dev/null
+++ b/deptrack/doc/deptrackrc
@@ -0,0 +1,15 @@
+# default values for ~/.deptrackrc
+# $Id$
+
+# database
+db_db          =       "deptrack"
+db_host                =       "localhost"
+db_pwd         =       ""
+db_user                =       "deptrack"
+
+# files and masks
+include_path   =       "."
+mask_img       =       "\.(png|gif|jpg)$"
+mask_inc       =       "\.inc(\.php)?$"
+mask_php       =       "(?<!\.inc)\.php$"
+