home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SBBS1B00.ZIP / DOCS.EXE / DOCS / FORMATS.DOC < prev    next >
Text File  |  1992-09-25  |  10KB  |  269 lines
  1. Synchronet File Formats (Technical Jargon)
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Configuration (CFG) Files
  5. ~~~~~~~~~~~~~~~~~~~~~~~~~
  6. Straight ASCII format. Each line contains an option. The data portion of the
  7. line ends at the first TAB character or column 41, whichever comes first. The
  8. remainder of the line is used to describe the option the line is used for.
  9. For Yes/No options, only the first character is checked and is not case
  10. sensitive. Field descriptions (comments) are created by SCFG automatically when
  11. changes are saved.
  12.  
  13. See the comments of the individual CFG files for the format of each.
  14.  
  15.  
  16. Index Files
  17. ~~~~~~~~~~~
  18.  
  19. INDX\MAIL.IXT
  20.  
  21.     The E-Mail index file is ASCII text. Each piece of mail occupies
  22.     three CR/LF delimited lines of text.
  23.  
  24.     Line 1:
  25.         filenameMdatetimeFuserfrom
  26.  
  27.         where "filename" is the eight character name of the actual
  28.         mail message that is stored in the DATA\MAIL directory with
  29.         a .MSG extension. The filename is in the format <tttfffcc>
  30.         where "ttt" is the number of the user whom the message is to
  31.         in hex, "fff" is the number of the user whom the message is
  32.         from in hex, and "cc" is the message counter in hex (so
  33.         multiple messages from one user to another have unique names).
  34.  
  35.         "M" is the mode of the message. To obtain the mode, subtract
  36.         32 (20 hex) from the ASCII value of this character. Each bit
  37.         represents a mode flag for this message. A normal message has
  38.         a mode of 0. The bits and their definitions are as follows:
  39.  
  40.             bit 0:    Forwarded Message
  41.             bit 1:    Anonymous Message
  42.  
  43.         "datetime" is the date/time stamp the e-mail was written in
  44.         Unix time format (number of seconds past Jan 1 1970) and stored
  45.         as ASCII hex.
  46.  
  47.         "F" is the flag for this message. Unread normal messages have
  48.         a flag of '*'. Unread validation feedback messages have a flag
  49.         of 'V'. Unread messages from the sysop have a flag of '$'.
  50.         Read messages normally have a flag of ' ' (space). The sysop
  51.         can set a message's flag to any ASCII character from the mail
  52.         read prompts.
  53.  
  54.         "userfrom" is a variable length record that contains the name
  55.         of the user who sent the message.
  56.  
  57.     Line 2:
  58.         The second line contains the name of the user whom the message
  59.         was sent to.
  60.  
  61.     Line 3:
  62.         The third line contains the title of the message.
  63.  
  64.  
  65. INDX\SUBS\*.IXT
  66.  
  67.     Each sub-boards index is stored as a different file using the sub's
  68.     internal code as the filename and .IXT as the extension. The files
  69.     are stored in the INDX\SUBS directory. The files are ASCII text with
  70.     each message's information stored on there CR/LF delimited lines.
  71.  
  72.     The first two lines of the file are fixed length (zero padded). The
  73.     first line is the number of messages in the index 5 decimal digits wide
  74.     (example: 00250). The second line is the date/time stamp of the last
  75.     message pointer in the index 8 hexadecimal digits wide (unix format)
  76.     (example: 27f4b03d).
  77.  
  78.     Line 1:
  79.         filenameMdatetime userfrom
  80.  
  81.         where "filename" is the eight character name of the actual
  82.         message stored in the DATA\SUBS\<CODE> directory with a .MSG
  83.         extension. The format of "filename" is <ttfffccc> where "tt"
  84.         is the message type: "LU" for a local user message, "QN" for
  85.         a QWK network node, "QH" for a QWK network hub, or "FN" for
  86.         a FidoNet node; "fff" is the number of the user whom the
  87.         message is from (LU or QN), QWK hub number (QH) or FidoNet node
  88.         number (FN) in hex, and "ccc" is the count in hex.
  89.  
  90.         "M" is the message mode. Subtract 32 (20 hex) from the ASCII
  91.         value stored in this position to obtain the actual message
  92.         mode. The defined bits are:
  93.  
  94.             bit 0:    Permanent Message (Won't be auto-purged)
  95.             bit 1:    Anonymous Message
  96.             bit 2:    Private Message
  97.  
  98.         "datetime" is the date/time stamp the message was created
  99.         in Unix format, stored in ASCII hex.
  100.  
  101.         "userfrom" contains the name of the user who posted this
  102.         message.
  103.  
  104.     Lines 2:
  105.         datetime userto
  106.  
  107.         where "datetime" is the date/time stamp that the message
  108.         was placed online (used for new message scanning), and "userto"
  109.         is the name of the user who the message is to (usually blank).
  110.  
  111.     Line 3:
  112.         Line three contains the title of the message.
  113.  
  114.  
  115. INDX\DIRS\*.IXB
  116.  
  117.     Each file directory's index is stored as an individual file in the
  118.     INDX\DIRS directory with the directory's code as the filename and
  119.     .IXB as the extension. These files are binary should be opened
  120.     "Read Only/Deny None" unless you have specific reasons to open with
  121.     other access rights.
  122.  
  123.     Each file entry is 22 bytes. The first eleven bytes are the name
  124.     and extension of the file. The name occupies the first 8 bytes of the
  125.     record (left justified and padded with spaces), the extension occupies
  126.     bytes 8 through 10 (i.e. no space between the name and extension).
  127.     Bytes 11 through 13 contain the data entry offset (byte 11 low, 12 mid,
  128.     and 13 high). Bytes 14 through 17 contain the date/time stamp the file
  129.     was uploaded (in seconds past Jan 1 1970), and bytes 18 through 21
  130.     contain the date/time stampe the file was last downloaded. The
  131.     following chart should be helpful in visualizing the format:
  132.  
  133.     Offset        Length        Description
  134.     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  135.     0        11        Filename (example: FILE    EXT)
  136.     11        3        Data record offset (LB,MB,HB)
  137.     14        4        Date/Time uploaded (Unix format)
  138.     18        4        Date/Time last downloaded
  139.  
  140.  
  141. Data Files
  142. ~~~~~~~~~~
  143.  
  144. DATA\DIRS\*.DAT
  145.  
  146.     Each file directory's file data is stored in a different file using
  147.     the directory's code as the filename and .DAT as the extension. These
  148.     files are stored in the DATA\DIRS directory. These files are ASCII
  149.     text using ETX (End of text - ASCII 3) to specifiy the end of a field
  150.     to maintain fixed length records. If a file's record starts with an
  151.     ETX, that record is not in use and is available for a new file's data.
  152.  
  153.     To find the data record for a file, you must first obtain the offset
  154.     into the data file from the corresponding IXB file.
  155.  
  156.     The following table should help visualize the file format. Fields that
  157.     have a length ending in "+2" indicate that the field is terminated
  158.     with a CR/LF. All numeric values are stored in decimal format unless
  159.     otherwise noted.
  160.  
  161.     Offset        Length        Description
  162.     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  163.     0        7+2        Credit value
  164.     9        58+2        Description
  165.     69        30+2        Uploader
  166.     101        5+2        Number of times downloaded
  167.     108        3+2        Open count
  168.     113        1        Miscellaneous bits
  169.     114        2+2        Alternate path (hex)
  170.  
  171.     If the first byte of the "Credit value" field is an ETX, this record
  172.     is not in use and can be eliminated by a future upload, or by executing
  173.     the ;RESORT sysop transfer section command.
  174.  
  175.     The last 5 bytes (before the CR/LF) in the "Uploader" field are not
  176.     used.
  177.  
  178.     The "Open count" field is the counter for keeping track of the number
  179.     of simultaneous openings of a file. A file record is "opened" when a
  180.     user starts to download it, adds it to a batch download queue, or
  181.     is editing it. A file with it's record currently open can not removed,
  182.     moved, or edited.
  183.  
  184.     The misecllaneous bits field has only one bit currently defined:
  185.  
  186.         bit 0:    Extended description exists for this file
  187.  
  188.     If an extended description exists for this file, it will be stored as:
  189.  
  190.     DATA\DIRS\<code>.EXT\<filename.ext>
  191.  
  192.     where <code> is the internal code for the directory and <filename.ext>
  193.     is the filename and extension of the file the description is for.
  194.  
  195.     The "Alternate path" field contains the number of the alternate path
  196.     (or 0 if default path for directory is used) in hex. The actual
  197.     location of this file is in the alternate path referenced in XFER.CFG.
  198.  
  199.  
  200. XTRN.DAT
  201.  
  202.     This is the data file that Synchronet creates for Synchronet specific
  203.     external programs. It is an ASCII text file with the format as follows:
  204.  
  205. Sample Data                Description
  206. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  207. Digital Man                User name
  208. Vertrauen                System name
  209. digital man                System operator
  210. The Guru                System guru
  211. ..\CTRL\                CTRL directory
  212. ..\DATA\                DATA directory
  213. 5                    Total nodes on system
  214. 5                    Current node number
  215. 19448                    Time left online
  216. Yes                    ANSI ? (Yes/No/Mono)
  217. 24                    Lines per screen
  218. 10770335                Credits
  219. 99                    Main Level
  220. 99                    Transfer Level
  221. 12/31/69                Birthdate
  222. M                    Sex
  223. 1                    User number
  224. 714-529-9525                User phone number
  225. 0                    COM port (0 if no modem or local)
  226. 3                    COM port IRQ
  227. 2f8                    COM port I/O address (in hex)
  228. 2400                    COM port DTE rate
  229. No                    Modem uses hardware flow ctrl (Y/N)
  230. No                    Modem locked at DTE rate (Y/N)
  231. ATQ0V0E0M1X4&C1&D2H0            Modem initialization string
  232.                     Modem special init string
  233. ATV1E1X4                Modem terminal mode init string
  234. ATDT                    Modem dial prefix
  235. ATH1M0                    Modem off-hook string
  236. ATA                    Modem answer string
  237. 795154132                Address of Modem Status Register
  238. 11                    Number of External Programs
  239. Global War                Names of External Programs (or blank
  240. Trade Wars 2002                 if user doesn't have access)
  241. Food Fight!
  242. Pit Fiend ][
  243. Dice War
  244. Synchronet Blackjack!
  245. Domain Poker
  246. Phantasia
  247. Emperor
  248. Synchronet Upgrade Door
  249. Credit Card Order Door
  250.  
  251.  
  252. MODUSER.DAT
  253.  
  254.     This is an optional file created by external programs to modify the
  255.     data of the current user. It is an ASCII text file with the format:
  256.  
  257. Sample Data                Description
  258. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  259. -500                    Credit Adjustment
  260. 60                    Main Level
  261. 60                    Transfer Level
  262. AB  E    I                Main Flags
  263.       G                 Transfer Flags
  264. A           P   T            Exemptions
  265.                     Restrictions
  266.  
  267.  
  268. /* End of FORMATS.DOC */
  269.