Documentation/English (British)/developer-chapter1-settings-edit.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>Xestia Scanner Server Documentation - Developer Documentation - 1.33 xestiascan_settings_edit</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Xestia Scanner Server</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.33 xestiascan_settings_edit</span>\r
  19 <br><br>\r
  20 xestiascan_settings_edit edits the settings for the Xestia Scanner Server installation. The settings can only be edited if the user has administrative privileges.\r
  21 <br><br>\r
  22 <b>Parameters:</b>\r
  23 <br><br>\r
  24 <div class="code">\r
  25 xestiascan_settings_edit(options);\r
  26 </div>\r
  27 <br><br>\r
  28 <b>Usage:</b>\r
  29 <br><br>\r
  30 <div class="code">\r
  31 $pagedata = xestiascan_settings_edit(%options);\r
  32 </div>\r
  33 <br><br>\r
  34 <i>options</i><br>\r
  35 Specifies the new settings as a hash. The settings accepted are:\r
  36 <br><br>\r
  37 <table class="infotable">\r
  38  <tr>\r
  39   <td class="tableheading">Setting</td>\r
  40   <td class="tableheading">Description</td>\r
  41  </tr>\r
  42  <tr>\r
  43   <td class="tabledata">ImagesURIPath</td>\r
  44   <td class="tabledata">Specifies the URI path of the images directory (used for graphics to make the page look more pleasing).</td>\r
  45  </tr>\r
  46  <tr>\r
  47   <td class="tabledata">ScansURIPath</td>\r
  48   <td class="tabledata">Specifies the URI path of the scans directory.</td>\r
  49  </tr>\r
  50  <tr>\r
  51   <td class="tabledata">ScansFSPath</td>\r
  52   <td class="tabledata">Specifies the filesystem path of the scans directory.</td>\r
  53  </tr>\r
  54  <tr>\r
  55   <td class="tabledata">DateTimeFormat</td>\r
  56   <td class="tabledata">Specifies the date and time format to use.</td>\r
  57  </tr>\r
  58  <tr>\r
  59   <td class="tabledata">SystemLanguage</td>\r
  60   <td class="tabledata">Specifies the language to use for Xestia Scanner Server.</td>\r
  61  </tr>\r
  62  <tr>\r
  63   <td class="tabledata">PresentationModule</td>\r
  64   <td class="tabledata">Specifies the presentation module to use.</td>\r
  65  </tr>\r
  66  <tr>\r
  67   <td class="tabledata">AuthModule</td>\r
  68   <td class="tabledata">Specifies the authentication module to use.</td>\r
  69  </tr>\r
  70  <tr>\r
  71   <td class="tabledata">OutputModule</td>\r
  72   <td class="tabledata">Specifies the output module to use.</td>\r
  73  </tr>\r
  74  <tr>\r
  75   <td class="tabledata">DatabaseServer</td>\r
  76   <td class="tabledata">Specifies the address of the database server to use.</td>\r
  77  </tr>\r
  78  <tr>\r
  79   <td class="tabledata">DatabasePort</td>\r
  80   <td class="tabledata">Specifies the port to use to connect to the database server.</td>\r
  81  </tr>\r
  82  <tr>\r
  83   <td class="tabledata">DatabaseProtocol</td>\r
  84   <td class="tabledata">Specifies the protocol to use to connect to the database server.</td>\r
  85  </tr>\r
  86  <tr>\r
  87   <td class="tabledata">DatabaseSQLDatabase</td>\r
  88   <td class="tabledata">Specifies the name of the database to use.</td>\r
  89  </tr>\r
  90  <tr>\r
  91   <td class="tabledata">DatabaseUsername</td>\r
  92   <td class="tabledata">Specifies the username to use for authenticating on the database server.</td>\r
  93  </tr>\r
  94  <tr>\r
  95   <td class="tabledata">DatabasePassword</td>\r
  96   <td class="tabledata">Specifies the password to use for authenticating on the database server.</td>\r
  97  </tr>\r
  98  <tr>\r
  99   <td class="tabledata">DatabasePasswordKeep</td>\r
 100   <td class="tabledata">Specifies if the existing password for authenticating on the database server should be kept.</td>\r
 101  </tr>\r
 102  <tr>\r
 103   <td class="tabledata">DatabaseTablePrefix</td>\r
 104   <td class="tabledata">Specifies the table prefix to use.</td>\r
 105  </tr>\r
 106  <tr>\r
 107   <td class="tabledata">Confirm</td>\r
 108   <td class="tabledata">Confirms the action to edit the settings.</td>\r
 109  </tr>\r
 110 </table>\r
 111                 </div>\r
 112         </body>\r
 113 </html>\r