Documentation/English (British)/user-chapter1-obtainingkiriwrite.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Kiriwrite Documentation - User Documentation - 1.1: Obtaining Kiriwrite</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Kiriwrite</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">1.1 Obtaining Kiriwrite</span><br><br>\r
  19 Kiriwrite can be obtained either through the Subversion repository or extracted from a source archive that is available on Kiriwrite homepage.<br><br>\r
  20 <span class="heading">1.1.1: Archive Extraction</span><br><br>\r
  21 The contents of the Kiriwrite archive can be extracted using gzip if it's a Gzip archive, bzip2 if it's a Bzip2'ed archive, 7za if it's a 7-Zip archive and unzip if it's a ZIP archive.<br><br>\r
  22 Bear in mind the following is done from a command console. GUI interfaces can also do the same as preformed here and mainly involves opening the archive and clicking on the Extract/Extract All button or simply dragging the folder containing from out of the archive (usually making a copy of the contents in the archive).<br><br>\r
  23 \r
  24 <div class="messagebox">\r
  25     <div class="message note">\r
  26         <b>Note</b><br>\r
  27         The naming convention of the Kiriwrite archives go as the following:<br><br>\r
  28         <div class="code">\r
  29             kiriwrite-x.y.z(-e).arc\r
  30         </div>\r
  31         <br>\r
  32         Where x is the major version, y is the minor version and z is the revision with (-e) meaning a very tiny modification that had to be done that did not merit an increment to the revision number.\r
  33     </div>\r
  34 </div>\r
  35 \r
  36 <br>\r
  37 \r
  38 When downloading an archive, the archive can be checked (by downloading the file with the same name but with .sha256 or .md5 added to the end of it) using shasum<sup>1</sup> or md5sum by doing the following to ensure it is downloaded correctly:<br><br>\r
  39 \r
  40 <div class="code">\r
  41     shasum -a 256 kiriwrite-x.y.z(-e).arc<br>\r
  42     md5sum kiriwrite-x.y.z(-e).arc\r
  43 </div>\r
  44 \r
  45 <br>\r
  46 \r
  47 shasum or md5sum should then generate the SHA-256 or MD5 checksum that should match the one that appears in the file with .sha256 or .md5 appended to it. If it does not match (and the file containing the sha256 or md5sum hash is the correct version) then the archive should be downloaded again and repeat the same process.<br><br>\r
  48 To extract the gzip archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
  49 \r
  50 <div class="code">\r
  51     gzip -d -c <i>(path)</i>/kiriwrite-0.3.0.tar.gz | tar -xv\r
  52 </div>\r
  53 \r
  54 <br>\r
  55 \r
  56 A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\r
  57 To extract the bzip2 archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
  58 \r
  59 <div class="code">\r
  60     bzip2 -d -c <i>(path)</i>/kiriwrite-0.3.0.tar.bz2 | tar -xv\r
  61 </div>\r
  62 \r
  63 <br>\r
  64 \r
  65 A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\r
  66 To extract the ZIP archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
  67 \r
  68 <div class="code">\r
  69     unzip <i>(path)</i>/kiriwrite-0.3.0.zip\r
  70 </div>\r
  71 \r
  72 <br>\r
  73 \r
  74 A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\r
  75 To extract the 7Zip archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
  76 \r
  77 <div class="code">\r
  78     7za e <i>(path)</i>/kiriwrite-0.3.0.7z\r
  79 </div>\r
  80 \r
  81 <br>\r
  82 \r
  83 A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\r
  84 \r
  85 <span class="heading">1.1.2: Subversion Access</span><br><br>\r
  86 Kiriwrite can also be obtained through checking out the code from the Subversion repository.<br><br>\r
  87 \r
  88 <div class="messagebox">\r
  89     <div class="message note">\r
  90         <b>Note</b><br>\r
  91         Bear in mind that the code that is in the Kiriwrite Subversion repository is normally unstable and could very well cause unexpected problems (such as warnings that appear in the web server error log that can be easily fixed and alterations to the database structure which requires an upgrade script which hasn't been written yet for that particular version yet).\r
  92     </div>\r
  93 </div>\r
  94 \r
  95 <br>\r
  96 \r
  97 Kiriwrite can be obtained from the Subversion repository by doing the following in a command console after selecting the correct directory to put it in:<br><br>\r
  98 \r
  99 <div class="code">\r
 100     svn checkout svn://svn.berlios.de/kiriwrite/trunk\r
 101 </div>\r
 102 \r
 103 <br>\r
 104 \r
 105 A list of files then appear as they are received from the Subversion repository and placed in the directory the command console is currently in. To update the code stored locally with code that is in the Kiriwrite Subversion repository this command should be done after changing to the directory where the local copy of the Kiriwrite Subversion code is:<br><br>\r
 106 \r
 107 <div class="code">\r
 108     svn update\r
 109 </div>\r
 110 \r
 111 <br>\r
 112 \r
 113 A list of files will then appear showing which files has been updated.\r
 114 \r
 115 <div class="footnote"></div>\r
 116 <sup>1</sup> The version of shasum talked about here is the shasum script that is used by the Digest::SHA::PurePerl Perl module which can produce checksums in SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 which can be installed via CPAN.\r
 117                 </div>\r
 118         </body>\r
 119 </html>\r