Return to canon.h CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / notes / src

Annotation of 43BSD/contrib/notes/src/canon.h, revision 1.1.1.1

1.1       root        1: /*
                      2:  *     The canonical form of a note looks like this:
                      3:  *
                      4:  *     N:<systemname>:<uniqid>:<resps>
                      5:  *     <title>
                      6:  *     <authorname>:<author uid>
                      7:  *     <year of note written>:<month>:<day>:<hour>:<minute>
                      8:  *     <status>:<length of text>
                      9:  *     <text>
                     10:  *
                     11:  *     the canonical form of a response looks like:
                     12:  *
                     13:  *     R:<note system>:<note id>:<response system>:<response id>:<resp #>
                     14:  *     <authorname>:<author id>
                     15:  *     <year of response written>:<month>:<day>:<hour>:<minute>
                     16:  *     <status>:<length of text>
                     17:  *     <text>
                     18:  *
                     19:  *     the file containing these forms will usually look like this:
                     20:  *
                     21:  *     <NOTE>
                     22:  *     <resp 1>
                     23:  *     <resp 2>
                     24:  *     ...
                     25:  *     <resp n>
                     26:  *     <NOTE>
                     27:  *     <NOTE>  (previous note had no responses)
                     28:  *     <resp 1>
                     29:  *     ...
                     30:  *     <resp m>
                     31:  *
                     32:  *     For network transmissions, the file of notes/responses 
                     33:  *     to be transmitted will be built
                     34:  *     locally, and then we will use someone elses packet mechanisms
                     35:  *     to transmit the data to the remote site. The remote will take
                     36:  *     care of checking to see if they already have copies of things.
                     37:  *
                     38:  *     The format of an ALMOST generic note, sent to news as text:
                     39:  *
                     40:  *   #N:uicsovax:10100072:000:251
                     41:  *   uicsovax!essick      Apr  5 15:51:00 1982
                     42:  *   
                     43:  *   This is a silly little note that I shall dump to the
                     44:  *   news program. I hope that things work all correctly because I do not
                     45:  *   wish to bother much more with them.
                     46:  *   I still have to worry about bringing this stuff back into notesfiles!
                     47:  *   This is the last line.
                     48:  *   
                     49:  *
                     50:  *     The format of an ALMOST generic response, sent as text to news:
                     51:  *
                     52:  *   #R:uicsovax:10100068:uicsovax:10100070:004:331
                     53:  *   uicsovax!essick      Apr  5 15:47:00 1982
                     54:  *   
                     55:  *   This is a test note to see how well things are going with the news dumping
                     56:  *   back into the notesfile stuff.
                     57:  *   
                     58:  *   The previous line should have been blank. THis will be the last line
                     59:  *   ----------
                     60:  *   This is another response to the note. The first got lost somewhere.
                     61:  *   THis is the last line.
                     62:  *   
                     63:  *     The #R fields, in order, are:
                     64:  *     base note system and id, response system and id, resp status and
                     65:  *     number of bytes in the text.
                     66:  *     The note is similiar but has only the basenote system and id.
                     67:  *
                     68:  *     second is author and date, almost in ctime(3) format.
                     69:  *     third is always blank, no characters on it.
                     70:  *     there is always a newline at the end of the text, even if it 
                     71:  *     was not in the stored note/response. This keeps others happy
                     72:  *
                     73:  */

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.