Adding user-tracker.pl version 1.0
[user-tracker.git] / README
1 Homepage: http://jxself.org/user-tracker.shtml
2
3 This file is part of usertracker.pl. See the end of the file for license 
4 conditions.
5
6 usertracker.pl scans specified log files for information about logged-in 
7 users and adds the list of logged users to a file. I had a need to get this 
8 information for a system I was working on, couldn't find a program that 
9 worked exactly like I wanted, and came to the conclusion that it had to be 
10 made.
11
12 It's written in Perl and needs Getopt::Long, Pod::Usage, YAML, 
13 File::ReadBackwards, and Date::Manip.
14
15 Run usertracker.pl -h to get more information.
16
17 In order to specify the log files and the patterns to match, you must specify 
18 the appropriate values in user-track.cfg.
19
20 user-track-cfg is in YAML format: http://en.wikipedia.org/wiki/YAML
21 A sample file is included, just follow the pattern and it will work. For each 
22 log you want to parse, you must specify 3 values: First, Second and Pattern:
23
24     Pattern is the regular expression that will match the date and the user 
25     in the line.
26
27     First and Second specifies the expected order in the line of the date and 
28     user field.
29
30 There is another file that will keep track of the last time it was run, the 
31 file is user-tracker.run, if will be created the first time the script is run 
32 (you'll receive a warning message).
33
34 usertracker.pl is copyright (C) 2013 Jason Self
35
36 usertracker.pl gives you software freedom; you can copy, modify, convey, 
37 and/or redistribute it under the terms of the GNU General Public License as 
38 published by the Free Software Foundation; either version 3 of the License, 
39 or (at your option) any later version.
40
41 This program is distributed in the hope that it will be useful, but WITHOUT 
42 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
43 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
44
45 You should have received a copy of the GNU General Public License along with 
46 this program in a file called 'GPLv3.txt'. If not, see 
47 http://www.gnu.org/licenses/gpl-3.0-standalone.html or write to the: Free 
48 Software Foundation, Inc., 51 Franklin St, Fifth Floor Boston, MA 02110-1301, 
49 USA.