Documentation cleanup
This commit is contained in:
parent
75c50ca55a
commit
fcaeda281a
2
CHANGES
2
CHANGES
|
@ -1,4 +1,4 @@
|
||||||
0.2 2009-07
|
0.2 2009-08-12
|
||||||
- added support for signed numbers that mirrors perl's
|
- added support for signed numbers that mirrors perl's
|
||||||
- fixed native endian selection bug
|
- fixed native endian selection bug
|
||||||
- added w (BER: Binary Encoded Representation)
|
- added w (BER: Binary Encoded Representation)
|
||||||
|
|
2
README
2
README
|
@ -1,6 +1,6 @@
|
||||||
CL-PACK
|
CL-PACK
|
||||||
Dan Ballard <http://mindstab.net>
|
Dan Ballard <http://mindstab.net>
|
||||||
June 2009
|
August 2009
|
||||||
|
|
||||||
CL-PACK supplier perl/php/ruby compatible pack() and unpack() functions to allow easy use of binary protocols with the above mentioned languages and C.
|
CL-PACK supplier perl/php/ruby compatible pack() and unpack() functions to allow easy use of binary protocols with the above mentioned languages and C.
|
||||||
|
|
||||||
|
|
17
cl-pack.lisp
17
cl-pack.lisp
|
@ -51,8 +51,9 @@
|
||||||
;;;d double precision float
|
;;;d double precision float
|
||||||
|
|
||||||
;;;x null byte
|
;;;x null byte
|
||||||
;;;X Backup a byte
|
;;;X Backup a byte (pack only)
|
||||||
|
|
||||||
|
;;; (pack only)
|
||||||
;;;@ Null fill or truncate to absolute position specified by repeater
|
;;;@ Null fill or truncate to absolute position specified by repeater
|
||||||
;;;. Null fill or truncate to absolute position specified by value/argument
|
;;;. Null fill or truncate to absolute position specified by value/argument
|
||||||
|
|
||||||
|
@ -85,6 +86,14 @@
|
||||||
;;; () Example: (pack "(cc)3" 65 66 67 68 69 70) => "ABCDEF"
|
;;; () Example: (pack "(cc)3" 65 66 67 68 69 70) => "ABCDEF"
|
||||||
;;; Example: (unpack "(cc)3") "ABCDEF") => (65 66) (67 68) (69 70)
|
;;; Example: (unpack "(cc)3") "ABCDEF") => (65 66) (67 68) (69 70)
|
||||||
|
|
||||||
|
;;; ***** / Template *****
|
||||||
|
;;; sequence length / sequence item
|
||||||
|
;;; in pack, writes out how ever many sequence items PRECEDED by the length
|
||||||
|
;;; in the form of sequence length
|
||||||
|
;;; example: (pack "a/c3" 65 66 67) => "3ABC"
|
||||||
|
;;; in unpack, reads the length and unpacks that many
|
||||||
|
;;; example: (unpack "a/c" "3ABC") => (65 66 67)
|
||||||
|
|
||||||
;;; **** NOTE *****
|
;;; **** NOTE *****
|
||||||
|
|
||||||
;;; A lot use users of pack() and unpack() in other languages
|
;;; A lot use users of pack() and unpack() in other languages
|
||||||
|
@ -94,12 +103,6 @@
|
||||||
;;; specified
|
;;; specified
|
||||||
;;; in cl-pack you can also use q< , q> , Q< and Q>
|
;;; in cl-pack you can also use q< , q> , Q< and Q>
|
||||||
|
|
||||||
;;; ************* TODO ***************
|
|
||||||
|
|
||||||
;;;! MODIFIER, different uses in context
|
|
||||||
;;; / template
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
;;; ***************** CL-PACK **********************
|
;;; ***************** CL-PACK **********************
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue