Browse Source

Update and clean up docs

More truth, less BS.
Alois Mahdal 10 years ago
parent
commit
7c4460713c
1 changed files with 21 additions and 24 deletions
  1. 21
    24
      README.md

+ 21
- 24
README.md View File

28
 
28
 
29
 Example:
29
 Example:
30
 
30
 
31
-    $ echo "Hello world" | ./bd.pl
31
+    $ echo "Hello world" | ./bd
32
     00000000  01001000 01100101 01101100 01101100  |Hell|
32
     00000000  01001000 01100101 01101100 01101100  |Hell|
33
     00000004  01101111 00100000 01110111 01101111  |o wo|
33
     00000004  01101111 00100000 01110111 01101111  |o wo|
34
     00000008  01110010 01101100 01100100 00001010  |rld.|
34
     00000008  01110010 01101100 01100100 00001010  |rld.|
65
 
65
 
66
 ### mkexec ###
66
 ### mkexec ###
67
 
67
 
68
-Make executable script for you and heat up vim.  Accepts filename as parameter.
68
+    mkexec [-f] [-e] name [type] [purpose]
69
 
69
 
70
-1.  try to guess type from name (e.g. .pl -> perl)
71
-2.  if filename does not exist, create it with shebang (based on `which` call)
72
-3.  chmod it to `0755` (yeah, hardcoded `0755`, no smartness here whatsoever)
73
-4.  try to heat up `vim` or `editor` for you.
70
+Make executable script, i.e. create new file, add shebang line and template,
71
+and mark it executable (0755).  type (py, pl, bash...) and purpose (test
72
+or nothing) are used to choose the right template.  If not supplied, attempt
73
+is made to guess from the filename.
74
 
74
 
75
+If the file already  exist, gives up, unless *-f* option is passed.  *-e*
76
+option causes default editor to be spawned with the new file loaded.
75
 
77
 
76
-### pfile ###
77
 
78
 
78
-Wrapper around *file* utility that reads STDIN, stores it in a temporary file
79
-(using Python's *tmpfile.mkstemp*),calls the utility on it and returns output
80
-(and of course, deletes the tmpfile afterwards).
79
+### pfile ###
81
 
80
 
82
-This is useful in cases like when debugging a HTTP server with utility like
83
-*curl*, and when we don't want to see the actual output, yet still want to know
84
-what it looks like.  Using pfile on pipe, we can easily combine the power
85
-of *file* with the simplicity of *curl*:
81
+Wrapper around *file* utility.  Reads STDIN, stores it in a temporary file
82
+(using Python's *tmpfile.mkstemp*), calls *file* on it and returns output.
86
 
83
 
84
+This is useful in cases like debugging a HTTP server with utility like
85
+*curl*, and when we don't want to see the actual output, yet still want to
86
+know what it looks like.  Using pfile on pipe, we can easily combine the
87
+power of *file* with the simplicity of *curl*:
87
 
88
 
88
     us@here:~$ curl -4 -v http://www.example.com/ | pfile
89
     us@here:~$ curl -4 -v http://www.example.com/ | pfile
89
     * About to connect() to www.example.com port 80 (#0)
90
     * About to connect() to www.example.com port 80 (#0)
115
 
116
 
116
 ### pl2yml, yml2pl ###
117
 ### pl2yml, yml2pl ###
117
 
118
 
118
-Simple scripts to read YAML/Perl data structure from a file and dump it in
119
-the other format to STDIN.  Uses [YAML::Tiny][4] for YAML jobs.
119
+Read YAML/Perl data structure from a file and dump it in the other format
120
+to STDIN.  Uses [YAML::Tiny][4] for YAML jobs.
120
 
121
 
121
   [4]: https://metacpan.org/module/YAML::Tiny
122
   [4]: https://metacpan.org/module/YAML::Tiny
122
 
123
 
123
 
124
 
124
 ### se ###
125
 ### se ###
125
 
126
 
126
-Translate to and from Czech.  Especially sweet if you need to concentrate
127
-on the work, i.e. avoid all the blinking flashing smiling Internets looks.
128
-This guy only tells you the woords.
127
+Translate to and from Czech using slovnik.cz service.
129
 
128
 
130
     se [options] word
129
     se [options] word
131
 
130
 
132
-Throw a word at it and by default, it will throw you back few Czech
133
-translations of it, one pair per line.  Sweet.  Also supports other languages
134
-(about 10 in total).
131
+By default, outputs few Czech translations of it, one per line.  Also
132
+supports other languages (about 10 in total).
135
 
133
 
136
 Most useful options are `--lines` (default is 25), `--long`, as shorthand
134
 Most useful options are `--lines` (default is 25), `--long`, as shorthand
137
 to `--lines=50`, and `--direction`, which supports direction keyword in form
135
 to `--lines=50`, and `--direction`, which supports direction keyword in form
169
 
167
 
170
 ### watchdump ###
168
 ### watchdump ###
171
 
169
 
172
-Trivial utility that prints a text file, clears the screen and pauses for 2s
173
-over and over.
170
+Prints a text file, clears the screen and pauses for 2s over and over.
174
 
171
 
175
 Designed mainly for use with `helper::dmup();` to enable you to see changes
172
 Designed mainly for use with `helper::dmup();` to enable you to see changes
176
 in your dumped data structure continuously, but obviously you can use it for
173
 in your dumped data structure continuously, but obviously you can use it for