draft-ukai-mu-protocol.txt

   1 Isoternet Draft              Mu Protocol                  September 10, 2000
   2
   3
   4                                                              Fumitoshi UKAI
   5                                                                    UKAI.ORG
   6 Isoternet Draft
   7 <draft-ukai-mu-protocol-02.txt>
   8 Expires six months from:                                   September 10, 2000
   9
  10                             Mu Protocol
  11                         draft-ukai-mu-protocol-02.txt
  12
  13
  14
  15 Status of this Memo
  16
  17      This document is an Isoternet-Draft.
  18
  19 Copyright Notice
  20
  21    Copyright (C) 2000 Fumitoshi UKAI. All Rights Reserved.
  22
  23 1.   Abstract
  24
  25 This draft serve as a formal definition of the Mu Protocol.
  26 The Mu Protocol has been used as a method for notifying
  27 URL to other members in some IRC channel, where "fumi-kun"
  28 is listening.
  29
  30 2. Conventions used in this document
  31
  32 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
  33 "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in
  34 this document are to be interpreted as described in [KEYWORDS].
  35
  36 3. Protocol Overview
  37
  38 For a long time, we have used some convention to notify some
  39 interesting URL on IRC channel.  We called it as "mu" protocol,
  40 because we usually say "\e$B$`\e(B URL" or "\e$B$`\e(B URL <comment for this URL>"
  41 in such case.  It's very easy way and this information is very
  42 useful for us, and we hope for everyone.  Therefore, we use it
  43 to collect useful URL informaton on IRC channel.
  44
  45 4. Formal Syntax
  46
  47 The following syntax specification uses the augmented Backus-Naur
  48 Form (BNF) as described in [ABNF]
  49
  50 Except as noted otherwise, all alphabetic characters are case-
  51 sensitive.
  52
  53
  54    CR = %x0D    ;; ASCII CR, carriage return
  55
  56    CRLF = CR LF
  57
  58    LF = %x0A    ;; ASCII LF, line feed
  59
  60    SP = %x20    ;; ASCII SPACE, space
  61
  62    HTAB = %x09  ;; ASCII HTAB, horizontal tab
  63
  64    WSP = SP / HTAB
  65
  66    ESC = %x1B   ;; ASCII ESC, escape
  67
  68    VCHAR = %x21-7E / ESC
  69                 ;; escape is included for ISO-2022-JP encoding [ISO-2022-JP]
  70
  71    Mu_Line = Mu_prefix 1*WSP URL 1*WSP Mu_comment CRLF
  72
  73    Mu_prefix = 1*VCHAR
  74
  75    URL = "http://" 1*VCHAR / "ftp://" 1*VCHAR / "news:" 1*VCHAR
  76
  77    Mu_comment = 1*VCHAR
  78
  79 5.   Examples
  80
  81    \e$B$`\e(B http://ukai.org/mu/draft-ukai-mu-protocol-01.txt \e$B$`%W%m%H%3%k$N%I%i%U%H\e(B
  82
  83    \e$B%`%`\e(B http://ukai.org/mu/ \e$B!V$`!W%Z!<%8$G$-$?$N$+\e(B
  84
  85 6.   Security Considerations
  86
  87    This draft does not discuss security.
  88
  89 References
  90
  91    [KEYWORDS] Bradner, S., "Key words for use in RFCs to Indicate
  92    Requirement Levels", RFC 2119, March 1997,
  93    <ftp://ftp.isi.edu/in-notes/rfc2119.txt>
  94
  95    [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications:
  96    ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd.,
  97    November 1997, <ftp://ftp.isi.edu/in-notes/rfc2234.txt>
  98
  99    [URL] T. Berners-Lee, L. Masinter, M. McCahill, "Uniform Resource
 100    Locators (URL)", RFC2368
 101
 102    [ISO-2022-JP] J. Murai, M. Crispin, E. van der Poel, "Japanese
 103    Character Encoding for Internet Messages", RFC1468, June 1993
 104
 105 Author's Address
 106
 107    Fumitoshi UKAI
 108    Takaido Higashi
 109    Suginami, Tokyo
 110    Japan
 111
 112    EMail: ukai@ukai.org