Annotation of 43BSD/contrib/news/misc/dirform, revision 1.1.1.1

1.1       root        1: #N
                      2: #S
                      3: #O
                      4: #C
                      5: #E
                      6: #T
                      7: #P
                      8: #L
                      9: #R
                     10: #W
                     11: #U
                     12: #
                     13: sitename       connection(FREQUENCY), connection(FREQUENCY),
                     14:        connection(FREQUENCY)
                     15: ============================================================================
                     16: 
                     17: The entire map is intended to be processed by pathalias, a program that
                     18: generates UUCP routes from this data.  All lines beginning in `#' are
                     19: comment lines to pathalias, however the UUCP Project has defined a set
                     20: of these comment lines to have specific format so that a complete
                     21: database could be built.
                     22: 
                     23: The generic form of these lines is
                     24: 
                     25: #<field id letter><tab><field data>
                     26: 
                     27: Each host has an entry in the following format.  The entry should begin
                     28: with the #N line, end with a blank line after the pathalias data, and
                     29: not contain any other blank lines, since there are ed, sed, and awk
                     30: scripts that use expressions like /^#N $1/,/^$/ for the purpose of
                     31: separating the map out into files, each containing one site entry.
                     32: 
                     33: #N     UUCP name of site
                     34: #S     manufacturer machine model; operating system & version
                     35: #O     organization name
                     36: #C     contact person's name
                     37: #E     contact person's electronic mail address
                     38: #T     contact person's telephone number
                     39: #P     organization's address
                     40: #L     longitude / latitude
                     41: #R     remarks
                     42: #U     netnews neighbors
                     43: #W     who last edited the entry ; date edited
                     44: #
                     45: sitename       remote1(FREQUENCY), remote2(FREQUENCY),
                     46:        remote3(FREQUENCY)
                     47: 
                     48: Example of a completed entry:
                     49: 
                     50: #N     ucbvax
                     51: #S     DEC VAX-11/750; 4.3 BSD UNIX
                     52: #O     University of California at Berkeley
                     53: #C     Robert W. Henry
                     54: #E     ucbvax!postmaster
                     55: #T     +1 415 642 1024
                     56: #P     573 Evans Hall, Berkeley, CA 94720
                     57: #L     37 52 29 N / 122 13 44 W 
                     58: #R     This is also UCB-VAX.BERKELEY.EDU [10.2.0.78] on the internet
                     59: #U     decvax ibmpa ucsfcgl ucbtopaz ucbcad
                     60: #W     ucbvax!fair (Erik E. Fair); Sat Jun 22 03:35:16 PDT 1985
                     61: #
                     62: ucbvax = "UCB-VAX.BERKELEY.EDU"
                     63: #
                     64: ucbvax decvax(DAILY/4), ihnp4(DAILY/2),
                     65:        sun(POLLED)
                     66: 
                     67: Specific Field Descriptions
                     68: 
                     69: #N     system name
                     70: 
                     71: Your system's UUCP name should go here. Either the uname(1) command
                     72: from System III or System V UNIX; or the uuname(1) command from Version
                     73: 7 UNIX will tell you what UUCP is using for the local UUCP name.
                     74: 
                     75: One of the goals of the UUCP Project is to keep duplicate UUCP host
                     76: names from appearing because there exist mailers in the world which
                     77: assume that the UUCP name space contains no duplicates (and attempts
                     78: UUCP path optimization on that basis), and it's just plain confusing to
                     79: have two different sites with the same name.
                     80: 
                     81: At present, the most severe restriction on UUCP names is that the name
                     82: must be unique somewhere in the first six characters, because of a poor
                     83: software design decision made by AT&T for the System V release of UNIX.
                     84: 
                     85: This does not mean that your site name has to be six characters or less
                     86: in length. Just unique within that length.
                     87: 
                     88: With regard to choosing system names, HARRIS'S LAMENT:
                     89: 
                     90:        ``All the good ones are taken.''
                     91: 
                     92: #S     machine type; operating system
                     93: 
                     94: This is a quick description of your equipment. Machine type should
                     95: be manufacturer and model, and after a semi-colon(;), the operating
                     96: system name and version number (if you have it). Some examples:
                     97: 
                     98:        DEC PDP-11/70; 2.9 BSD UNIX
                     99:        DEC PDP-11/45; ULTRIX-11
                    100:        DEC VAX-11/780; VMS 4.0
                    101:        SUN 2/150; 4.2 BSD UNIX
                    102:        Pyramid 90x; OSx 2.1
                    103:        CoData 3300; Version 7 UniPlus+
                    104:        Callan Unistar 200; System V UniPlus+
                    105:        IBM PC/XT; Coherent
                    106:        Intel 386; XENIX 3.0
                    107:        CRDS Universe 68; UNOS
                    108: 
                    109: #O     organization name
                    110: 
                    111: This should be the full name of your organization, squeezed to fit
                    112: inside 80 columns as necessary. Don't be afraid to abbreviate where the
                    113: abbreviation would be clear to the entire world (say a famous
                    114: institution like MIT or CERN), but beware of duplication (In USC the C
                    115: could be either California or Carolina).
                    116: 
                    117: #C     contact person
                    118: 
                    119: This should be the full name (or names, separated by commas) of the
                    120: person responsible for handling queries from the outside world about
                    121: your machine.
                    122: 
                    123: #E     contact person's electronic address
                    124: 
                    125: This should be just a machine name, and a user name, like
                    126: `ucbvax!fair'. It should not be a full path, since we will be able to
                    127: generate a path to the given address from the data you're giving us.
                    128: There is no problem with the machine name not being the same as the #N
                    129: field (i.e. the contact `lives' on another machine at your site).
                    130: 
                    131: Also, it's a good idea to give a generic address or alias (if your mail
                    132: system is capable of providing aliases) like `usenet' or `postmaster',
                    133: so that if the contact person leaves the institution or is re-assigned
                    134: to other duties, he doesn't keep getting mail about the system. In a
                    135: perfect world, people would send notice to the UUCP Project, but in
                    136: practice, they don't, so the data does get out of date. If you give a
                    137: generic address you can easily change it to point at the appropriate
                    138: person.
                    139: 
                    140: Multiple electronic addresses should be separated by commas, and all of
                    141: them should be specified in the manner described above.
                    142: 
                    143: #T     contact person's telephone number
                    144: 
                    145: Format: +<country code><space><area code><space><prefix><space><number>
                    146: 
                    147: Example:
                    148: 
                    149: #T     +1 415 642 1024
                    150: 
                    151: This is the international format for the representation of phone
                    152: numbers. The country code for the United States of America is 1. Other
                    153: country codes should be listed in your telephone book.
                    154: 
                    155: If you must list an extension (i.e. what to ask the receptionist for,
                    156: if not the name of the contact person), list it after the main phone
                    157: number with an `x' in front of it to distinguish it from the rest of
                    158: the phone number.
                    159: 
                    160: Example:
                    161: 
                    162: #T     +1 415 549 3854 x37
                    163: 
                    164: Multiple phone numbers should be separated by commas, and all of them
                    165: should be completely specified as described above to prevent confusion.
                    166: 
                    167: #P      organization's address
                    168: 
                    169: This field should be one line filled with whatever else anyone would
                    170: need after the contact person's name, and your organization's name
                    171: (given in other fields above), to mail you something in the physical
                    172: mails. Generally, if there's room, it's best to spell out things
                    173: like Road, Street, Avenue, and Boulevard, since this is an international
                    174: network, and the abbreviations will not necessarily be obvious to someone
                    175: from Finland, for example.
                    176: 
                    177: #L      longitude and latitude
                    178: 
                    179: This should be in the following format:
                    180: 
                    181: #L     NN MM [SS] N|S / NNN MM [SS] E|W  [city]
                    182: 
                    183: Two fields, with optional third.
                    184: 
                    185: First number is Latitude in degrees (NN), minutes (MM), and seconds (SS),
                    186: and a N or S to indicate North or South of the Equator.
                    187: 
                    188: A Slash Separator.
                    189: 
                    190: Second number is Longitude in degrees (NNN), minutes (MM), and seconds (SS),
                    191: and a E or W to indicate East or West of the Prime Meridian in Greenwich,
                    192: England.
                    193: 
                    194: Seconds are optional, but it is worth noting that the more accurate you
                    195: are, the more accurate maps we can make of the network (including
                    196: blow-ups of various high density areas, like New Jersey, or the San
                    197: Francisco Bay Area).
                    198: 
                    199: If you give the coordinates for your city (i.e. without fudging for
                    200: where you are relative to that), add the word `city' at the end of the
                    201: end of the specification, to indicate that. If you know where you are
                    202: relative to a given coordinate for which you have longitude and
                    203: latitude data, then the following fudge factors can be useful:
                    204: 
                    205: 1 degree       =       69.2 miles      =       111 kilometers
                    206: 1 minute       =       1.15 miles      =       1.9 kilometers
                    207: 1 second       =       101.5 feet      =       31 meters
                    208: 
                    209: The Prime Meridian is through Greenwich, England, and longitudes go no
                    210: higher than 180 degrees West or East of Greenwich. Latitudes go no
                    211: higher than 90 degrees North or South of the Equator.
                    212: 
                    213: Beware that the distance between two degrees of longitude decreases as
                    214: you get further away from the Equator. (Imagine all those longitudinal
                    215: lines converging on the north and south poles...) These numbers are
                    216: good for the Equator.  If you're in Alaska or Norway, for example, they
                    217: are certainly too large for you to fudge longitude accurately.
                    218: 
                    219: #R      remarks
                    220: 
                    221: This is for one line of comment. As noted before, all lines beginning
                    222: with a `#' character are comment lines, so if you need more than one
                    223: line to tell us something about your site, do so between the end of the
                    224: map data (the #?\t fields) and the pathalias data.
                    225: 
                    226: #U     netnews neighbors
                    227: 
                    228: The USENET is the network that moves netnews around, specifically,
                    229: net.announce. If you send net.announce to any of your UUCP neighbors,
                    230: list their names here, delimited by spaces. Example:
                    231: 
                    232: #U     ihnp4 decvax mcvax seismo
                    233: 
                    234: Since some places have lots of USENET neighbors, continuation lines
                    235: should be just another #U and more site names.
                    236: 
                    237: #W      who last edited the entry and when
                    238: 
                    239: This field should contain an email address, a name in parentheses,
                    240: followed by a semi-colon, and the output of the date program.
                    241: Example:
                    242: 
                    243: #W     ucbvax!fair (Erik E. Fair); Sat Jun 22 03:35:16 PDT 1985
                    244: 
                    245: The same rules for email address that apply in the contact's email
                    246: address apply here also. (i.e. only one system name, and user name).
                    247: It is intended that this field be used for automatic ageing of the
                    248: map entries so that we can do more automated checking and updating
                    249: of the entire map. See getdate(3) from the netnews source for other
                    250: acceptable date formats.
                    251: 
                    252: PATHALIAS DATA (or, documenting your UUCP connections & frequency of use)
                    253: 
                    254: The DEMAND, DAILY, etc., entries represent imaginary connect costs (see
                    255: below) used by pathalias to calculate lowest cost paths.  The cost
                    256: breakdown is:
                    257: 
                    258:        LOCAL           25      local area network
                    259:        DEDICATED       95      high speed dedicated
                    260:        DIRECT          200     local call
                    261:        DEMAND          300     normal call (long distance, anytime)
                    262:        HOURLY          500     hourly poll
                    263:        EVENING         1800    time restricted call
                    264:        DAILY           5000    daily poll
                    265:        WEEKLY          30000   irregular poll
                    266:        DEAD            a very high number - not usable path
                    267: 
                    268: Additionally, HIGH and LOW (used like DAILY+HIGH) are -5 and +5
                    269: respectively, for baud-rate or quality bonuses/penalties.  Arithmetic
                    270: expressions can be used, however, you should be aware that the results
                    271: are often counter-intuitive (e.g. (DAILY*4) means every 4 days, not 4
                    272: times a day).
                    273: 
                    274: The numbers are intended to represent frequency of connection, which
                    275: seems to be far more important than baud rates for this type of
                    276: traffic.  There is an assumed high overhead for each hop; thus,
                    277: HOURLY is far more than DAILY/24.
                    278: 
                    279: There are a few other cost names that sometimes appear in the map;
                    280: these are discouraged.  Some are synonyms for the prefered
                    281: names above (e.g. POLLED means DAILY), some are obsolete (e.g.
                    282: the letters A through F, which are letter grades for connections.)
                    283: It is not acceptable to make up new names or spellings (pathalias
                    284: gets very upset when people do that...).
                    285: 
                    286: LOCAL AREA NETWORKS
                    287: 
                    288: For local area networks, (since they are usually completely connected),
                    289: there is a list notation for specifying them. Usually there is one
                    290: gateway machine to the outside world; it is best that the definition of
                    291: the network appear in that system's pathalias entry, and the other
                    292: systems just note that they connect to the LAN.  An abbreviated map
                    293: entry for the sake of example:
                    294: 
                    295: #N     frobozz
                    296: #O     Frobozz Skonk Works
                    297: #C     Joe Palooka
                    298: #E     frobozz!postmaster
                    299: #R     gateway machine to Frobozz Company LAN
                    300: #
                    301: frobozz        ucbvax(DEMAND), ihnp4(EVENING), seismo(DAILY),
                    302:        mcvax(WEEKLY), akgua(EVENING)
                    303: #
                    304: #      LAN addressed user@host
                    305: #
                    306: FROBOZZ-ETHER = @{frobozz, frob1, frob2, frob3}(LOCAL)
                    307: #
                    308: #      LAN addressed BerkNet style host:user
                    309: #
                    310: FROBOZZ-BERKNET = {frobozz, frob4, frob5, frob6}:(LOCAL)
                    311: 
                    312: For the other sites on the LAN, their map entries should reflect
                    313: who is in charge of the machine, and their pathalias data
                    314: would appear like this (again, this example is abbreviated):
                    315: 
                    316: #N     frob1
                    317: #O     Frobozz Skonk Works, Software Development System
                    318: #C     Joe Palooka
                    319: #E     frobozz!postmaster
                    320: #
                    321: frob1  FROBOZZ-ETHER
                    322: 
                    323: WHAT TO DO WITH THIS STUFF
                    324: 
                    325: Once you have finished constructing your pathalias entry, mail it off
                    326: to {ucbvax,ihnp4,akgua,seismo}!cbosgd!uucpmap, which is a mailing list
                    327: of the regional map coordinators.  They maintain assigned geographic
                    328: sections of the map, and the entire map is posted on a rolling basis in
                    329: the USENET newsgroups mod.map.uucp over the course of a month (at the
                    330: end of the month they start over).
                    331: 
                    332: Questions or comments about this specification should also be directed at
                    333: cbosgd!uucpmap.
                    334: 

unix.superglobalmegacorp.com

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