html/names.html

   1 @section=site guide
   2 @heading=Names
   3 @header
   4
   5 <!-- This file is preprocessed by cgi/html.cgi -->
   6
   7 <p>If you&#x2019;ve arrived at this page you may have already encountered the
   8 dreaded &#x201c;<tt>contains bad characters</tt>&#x201d; or the
   9 &#x201c;<tt>Invalid project name</tt>&#x201d; or
  10 &#x201c;<tt>Invalid user name</tt>&#x201d; error message.</p>
  11
  12 <p>Read on to see what&#x2019;s allowed in user names and project names.</p>
  13
  14 <h3 id="project">Project Names</h3>
  15
  16 <p>Project names (this includes fork names) must meet the following conditions:</p>
  17
  18 <ul>
  19 <li>Project names must start with an alphanumeric character (the letters
  20 <tt>A</tt>-<tt>Z</tt>, <tt>a</tt>-<tt>z</tt> and the digits <tt>0</tt>-<tt>9</tt>).</li>
  21
  22 <li>The following characters must be alphanumeric or one of <tt>+</tt>, <tt>-</tt>,
  23 <tt>.</tt> or <tt>_</tt>.</li>
  24
  25 <li>The name must not end in <tt>.</tt>, <tt>.bundle</tt>, <tt>.git</tt> or <tt>.lock</tt>.</li>
  26
  27 <li>The name must not contain <tt>..</tt> anywhere.</li>
  28
  29 <li>It must not end in a reserved suffix (many common file type suffixes are reserved
  30 such as <tt>.html</tt>, <tt>.png</tt> etc.)</li>
  31
  32 <li>It must not be a reserved name (there are only a very few of these, most of them
  33 a single letter, so if a project name meets the above rules but was not allowed
  34 it&#x2019;s because it&#x2019;s a reserved name).</li>
  35 </ul>
  36
  37 <h3 id="user">User Names</h3>
  38
  39 <p>User names must meet the following conditions:</p>
  40
  41 <ul>
  42 <li>User names must start with an alphanumeric character (the letters
  43 <tt>A</tt>-<tt>Z</tt>, <tt>a</tt>-<tt>z</tt> and the digits <tt>0</tt>-<tt>9</tt>).</li>
  44
  45 <li>The following characters must be alphanumeric or one of <tt>+</tt>, <tt>-</tt>,
  46 <tt>.</tt> or <tt>_</tt>.</li>
  47
  48 <li>The name must not start with <tt>mob.</tt> or <tt>mob_</tt>.</li>
  49
  50 <li>The name must not end in <tt>.</tt>, <tt>.bundle</tt>, <tt>.git</tt> or <tt>.lock</tt>.</li>
  51
  52 <li>The name must not contain <tt>..</tt> anywhere.</li>
  53
  54 <li>It must not end in a reserved suffix (many common file type suffixes are reserved
  55 such as <tt>.html</tt>, <tt>.png</tt> etc.)</li>
  56
  57 <li>It must not be a reserved name (there are only a very few of these, so if
  58 a user name meets the above rules but was not allowed it&#x2019;s because
  59 it&#x2019;s a reserved name).</li>
  60 </ul>