Skip to content

Commit ce79575

Browse files
committed
readme changed to v3.0
1 parent 8c5d88e commit ce79575

File tree

1 file changed

+41
-25
lines changed

1 file changed

+41
-25
lines changed

README.md

Lines changed: 41 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
**circle** reads all bytes in a file, and counts and arranges them from 0x00 to 0xff. Then it calculates the Standard deviation (sigma) of the data, and arranges the 256 resulting buckets in a circle, in such a way that the distance from the centre is proportional to the byte value (with 0x00 at the center, and ...0xf0-0xff bytes the farthest from it). The char that represents each byte is proportional to the deviation from the mean, in fractions of the standard deviation.
44

5-
From v2.6, the list of different bytes counted can be printed using options `-l`, `-L`, `-Z`. Values over the mean will be printed green, and below it, they will be red.
5+
The list of different bytes counted can be printed using options `-l`, `-L`, `-Z`. Values over the mean will be printed green, and below it, they will be red.
6+
7+
Also the file can be sliced in slices of size # with `-s #`, or sliced in # slices with `-S #`.
8+
9+
Initial and end absolute bytes in the file can be indicated with `-f #` (from) and `-t #` (to) respectively. `-T #` (instead of `-t`) can be used to indicate the chunk size to analyze after `-f #` byte.
610

711
Installation
812
============
@@ -17,10 +21,10 @@ There is a PPA repository available for Ubuntu (contains versions from *precise*
1721
$ sudo apt-get update
1822
$ sudo apt-get install bytes-circle
1923

20-
There're [executable files for various OS available here](https://drive.google.com/folderview?id=0B1L_hFrWJfRhODE3RE5fNGNaWWM), including versions for Windows, HP-UX and Solaris.
21-
2224
If using [R](https://cran.r-project.org/), there's a port here: [https://github.com/circulosmeos/bytescircle](https://github.com/circulosmeos/bytescircle).
2325

26+
There're [executable files for various OS available here](https://drive.google.com/folderview?id=0B1L_hFrWJfRhODE3RE5fNGNaWWM), including versions for Windows, HP-UX and Solaris.
27+
2428
Compilation
2529
===========
2630

@@ -49,31 +53,43 @@ A random file looks like:
4953

5054
![](https://circulosmeos.files.wordpress.com/2015/10/circle-urandom.png)
5155

52-
Options for non-colored consoles (in this case chars represent increments of 0.5 sigma and zero is char '*') and for using numbers instead of ASCII art are also available:
56+
Options for non-colored consoles (in this case chars represent increments of 0.5 sigma and zero is char '*') and for using numbers instead of ASCII art are also available: `-[bnu]` or `-o {0|1|2|3}`.
57+
58+
Usage
59+
=====
5360

5461
$ bytes-circle -h
5562

56-
circle v2.6 (goo.gl/TNh5dq)
57-
58-
Show statistics about bytes contained in a file,
59-
as a circle graph of deviations from sigma.
60-
61-
Use:
62-
$ circle [-o {0|1|2|3}] [-BblLZnruvh] [-z {0-255}] [<filename>] [<filename>] ...
63-
64-
-o {0 | 1=no color | 2=numbers | 3=uncoloured numbers}
65-
-B : stop processing files on first error encountered
66-
-b : no color
67-
-l : list number of bytes counted, from 0 to 255
68-
-L : list number of bytes counted, excluding zero valued
69-
-Z : list number of bytes counted, but only zero valued
70-
-n : numbers
71-
-r : restrict statistics to the byte buckets that appear
72-
in the file, not to the 256 default value.
73-
-u : uncoloured numbers (-b -n)
74-
-v : prints version
75-
-h : prints this help
76-
-z {0-255} : prints a 2nd circle centered on this byte (0==127 !)
63+
circle v3.0 (goo.gl/TNh5dq)
64+
65+
Show statistics about bytes contained in a file,
66+
as an ASCII circle graph of deviations from mean
67+
in standard deviation (sigma) fraction increments.
68+
69+
Use:
70+
$ circle [-o {0|1|2|3}] [-bBglLZnruvh] [-[fsStT] #] [-z {0-255}] [<filename>] [<filename>] ...
71+
72+
-o : show sigma as {0=default | 1=no color | 2=numbers | 3=uncoloured numbers}
73+
-b : no color (Black & white)
74+
-B : ('Break') stop processing files on first error encountered
75+
-g : ('Global') show summary values for file, when using `-[sS]`
76+
-l : list number of bytes counted, from 0 to 255
77+
-L : list number of bytes counted, excluding zero valued
78+
-Z : list number of bytes counted, but only zero valued
79+
-n : show sigma as Numbers
80+
-r : restrict statistics to the byte buckets that appear
81+
in the file, not to the 256 default value
82+
-u : show sigma as Uncoloured numbers (equivalent to `-b -n`)
83+
-v : print version
84+
-h : print this help
85+
-f#: ('From') analyze file from # byte on (1 implicit). SI suffixes supported.
86+
-s#: Slice file in slices of size # bytes. SI suffixes supported.
87+
-S#: Slice file in # slices. SI suffixes supported.
88+
-t#: ('To') analyze file until # byte. SI suffixes supported.
89+
-T#: ('To') analyze this # bytes from `-f`. SI suffixes supported.
90+
-z {0-255} : print a 2nd circle centered on this byte (0==127 !)
91+
92+
Note about SI suffixes: kmgtpe (10^), KMGTPE (2^), and prefixes '0x' and '0'.
7793

7894
License
7995
=======

0 commit comments

Comments
 (0)