Browse Source

Updated document outline.

*   divided into bin, cgi-bin and lib sections
*   consolidated newlines before ##
*   changed heading 1 and 2 lvl style
Alois Mahdal 11 years ago
parent
commit
8d80ebb409
1 changed files with 78 additions and 61 deletions
  1. 78
    61
      README.md

+ 78
- 61
README.md View File

@@ -1,13 +1,64 @@
1
-#minions#
1
+minions
2
+=======
2 3
 
3 4
 My favorite tiny Perl scripts for development and testing.
4 5
 
5
-##hello_host.cgi##
6
+
7
+
8
+bin - UNIX scripts
9
+------------------
10
+
11
+
12
+### autotest.pl ###
13
+
14
+Script to make it easier to start developing your new Perl module under
15
+pressure of unit tests written in [Test::More][1] and the likes.
16
+
17
+  [1]: (http://perldoc.perl.org/Test/More.html)
18
+
19
+Suggested use is to sit on the other monitor, run all *.t* files around
20
+and around and be annoying about the fact that they fail.  Then the rule
21
+of thumb goes without saying: "no green, no commit".
22
+
23
+
24
+### timestamp.pl ###
25
+
26
+Script to measure how long mone second takes.  For those that know how long
27
+one second takes, it can serve as a snippet for Perl `&stamp()`.
28
+
29
+
30
+### watchdump.pl ###
31
+
32
+Trivial utility that prints a text file, clears the screen and pauses for 2s
33
+over and over.
34
+
35
+Designed mainly for use with `helper::dmup();` to enable you to see changes
36
+in your dumped data structure continuously, but obviously you can use it for
37
+any text file that will fit your screen.
38
+
39
+For improved visual feedack, it will pre-pend the file contents with the file
40
+path and an "animation".  Display of the header can be controlled by options,
41
+see `--usage`.
42
+
43
+
44
+### pl2yml.pl, yml2pl.pl ###
45
+
46
+Simple scripts to read YAML/Perl data structure from a file and dump it in
47
+the other format to STDIN.  Uses YAML::tiny for YAML jobs.
48
+
49
+
50
+
51
+cgi-bin - CGI scripts
52
+---------------------
53
+
54
+
55
+### hello_host.cgi ###
6 56
 
7 57
 Prints overview of TCP connection details (IP addresses, ports, server
8 58
 user@host, time); 7 lines of plain text.
9 59
 
10
-##htlog.cgi##
60
+
61
+### htlog.cgi ###
11 62
 
12 63
 Collects GET requests with parameters *msg*, *tag* and *i* and logs them into
13 64
 single text file.
@@ -20,7 +71,30 @@ single text file.
20 71
     it won't break your ability to use tags
21 72
 
22 73
 
23
-##htlogger.pm##
74
+### randomfile.pl ###
75
+
76
+Send a 7-bit plain-text file via HTTP.  One of these is sent:
77
+
78
+*   random content of random length given by parameters *min* and *max*
79
+
80
+*   EICAR test virus file
81
+
82
+Chance to receive EICAR is given by parameter *eicar* (0-100).
83
+
84
+
85
+
86
+lib - modules/libraries
87
+-----------------------
88
+
89
+
90
+### helper.pm ###
91
+
92
+Container module for some utility methods for Perl.  Probably only `dmup()`
93
+is interesting—it bears a nice quick and dirty way for dumping Perl
94
+data.
95
+
96
+
97
+### htlogger.pm ###
24 98
 
25 99
 API to make usage of *htlog.cgi* in Perl scripts even easier
26 100
 
@@ -51,60 +125,3 @@ API to make usage of *htlog.cgi* in Perl scripts even easier
51 125
         );
52 126
 
53 127
     }
54
-
55
-
56
-##autotest.pl##
57
-
58
-Script to make it easier to start developing your new Perl module under 
59
-pressure of unit tests written in [Test::More][1] and the likes.
60
-
61
-  [1]: (http://perldoc.perl.org/Test/More.html)
62
-
63
-Suggested use is to sit on the other monitor, run all *.t* files around 
64
-and around and be annoying about the fact that they fail.  Then the rule 
65
-of thumb goes without saying: "no green, no commit".
66
-
67
-
68
-##timestamp.pl##
69
-
70
-Script to measure how long mone second takes.  For those that know how long 
71
-one second takes, it can serve as a snippet for Perl `&stamp()`.
72
-
73
-
74
-
75
-##helper.pm##
76
-
77
-Container module for some utility methods for Perl.  Probably only `dmup()` 
78
-is interesting—it bears a nice quick and dirty way for dumping Perl 
79
-data.
80
-
81
-
82
-##watchdump.pl##
83
-
84
-Trivial utility that prints a text file, clears the screen and pauses for 2s
85
-over and over.
86
-
87
-Designed mainly for use with `helper::dmup();` to enable you to see changes
88
-in your dumped data structure continuously, but obviously you can use it for
89
-any text file that will fit your screen.
90
-
91
-For improved visual feedack, it will pre-pend the file contents with the file
92
-path and an "animation".  Display of the header can be controlled by options,
93
-see `--usage`.
94
-
95
-
96
-##randomfile.pl##
97
-
98
-Send a 7-bit plain-text file via HTTP.  One of these is sent:
99
-
100
-*   random content of random length given by parameters *min* and *max*
101
-
102
-*   EICAR test virus file
103
-
104
-Chance to receive EICAR is given by parameter *eicar* (0-100).
105
-
106
-
107
-##pl2yml.pl, yml2pl.pl##
108
-
109
-Simple scripts to read YAML/Perl data structure from a file and dump it in
110
-the other format to STDIN.  Uses YAML::tiny for YAML jobs.