ACC SHELL

Path : /usr/share/doc/packages/yast2-nfs-client/autodocs/
File Upload :
Current File : //usr/share/doc/packages/yast2-nfs-client/autodocs/routines.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html>
 <head>
  <title>

   Configuration of nfs
</title>
  <style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
 </head>
 <body>
  <div class="header">
   <i>YaST2 Developers Documentation:</i>
   <a href="index.html">
    <b>

   Configuration of nfs
</b>
   </a>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
   <hr />
  </div>
  <div class="menu">
   <img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
   <br />
   <br />
   <a href="index.html">functions</a>
   <br />
   <a href="files.html">files</a>
   <br />
   <a href="intro.html">intro</a>
  </div>
  <div class="main">
   <div class="sigbox">
    <table class="padtbl">
     <tr>
      <td>
       <h1>

   Configuration of nfs
</h1>
      </td>
      <td class="filecell">
   routines.ycp
</td>
     </tr>
     <tr>
      <td>
   Network NFS routines
</td>
     </tr>
     <tr>
      <td>
       <ul>
        <li>   Jan Holesovsky <kendy@suse.cz></li>
        <li>   Dan Vesely <dan@suse.cz></li>
       </ul>
      </td>
     </tr>
     <tr>
      <td>
       <p>This module has an unstable interface.</p>
      </td>
     </tr>
    </table>
    <table class="padtbl">
     <tr>
      <td>

 Network NFS routines


       <h1>Imports</h1>
       <ul>
        <li>Package</li>
        <li>Report</li>
       </ul>
       <h1>Local Functions</h1>
       <ul>
        <li>
         <a href="#CheckHostName">CheckHostName (string name)</a>
        </li>
        <li>
         <a href="#CheckPath">CheckPath (string name)</a>
        </li>
        <li>
         <a href="#FstabTableItems">FstabTableItems (list&lt;map&gt; fstab)</a>
        </li>
        <li>
         <a href="#IsMpInFstab">IsMpInFstab (list&lt;map&gt; fstab, string mpoint)</a>
        </li>
        <li>
         <a href="#IsPortmapperInstalled">IsPortmapperInstalled (string portmapper)</a>
        </li>
        <li>
         <a href="#SpecToServPath">SpecToServPath (string spec)</a>
        </li>
        <li>
         <a href="#StripExtraSlash">StripExtraSlash (string p)</a>
        </li>
        <li>
         <a href="#check_options">check_options (string options)</a>
        </li>
       </ul>
      </td>
     </tr>
    </table>
   </div>
   <p />
   <div class="sigbox">
    <span class="sig" id="SpecToServPath">local
     <b>SpecToServPath (string spec)
      <span class="a"> -&gt; </span>
      <span class="t">term</span>
     </b>
    </span>
   </div>
   <p></p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">spec</span>
       </td>
       <td class="descbox">"server:/path/specification"</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">`couple("server", "/path/specification")</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="FstabTableItems">local
     <b>FstabTableItems (list&lt;map&gt; fstab)
      <span class="a"> -&gt; </span>
      <span class="t">list&lt;term&gt;</span>
     </b>
    </span>
   </div>
   <p>
 Creates a list of ui table items for nfs fstab entries</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">fstab</span>
       </td>
       <td class="descbox">list of nfs fstab entries</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">itemized table entries</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Example</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td align="left" valign="top"><pre>
 UI::ChangeWidget(`id(`fstable), `Items, FstabTableItems(nfs_entries));</pre></td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="CheckHostName">local
     <b>CheckHostName (string name)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Check for the validity of a hostname: nonempty, shorter than 50 chars,
 [-A-Za-z._]. If invalid, a message is displayed.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">name</span>
       </td>
       <td class="descbox">a hostname</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">whether valid</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="IsMpInFstab">local
     <b>IsMpInFstab (list&lt;map&gt; fstab, string mpoint)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Check if a mountpoint is in the fstab. If yes, display a message.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">fstab</span>
       </td>
       <td class="descbox">in .etc.fstab format (must contain the key "file")</td>
      </tr>
      <tr>
       <td class="pbox">
        <span class="p">mpoint</span>
       </td>
       <td class="descbox">mount point</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">is it there?</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="CheckPath">local
     <b>CheckPath (string name)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Check for the validity of a path/mountpoint:
 nonempty, fewer than 70 chars, starts with a slash.
 If invalid, a message is displayed.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">name</span>
       </td>
       <td class="descbox">path</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">whether valid</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="check_options">local
     <b>check_options (string options)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Checks the nfs options for /etc/fstab:
 nonempty, comma separated list of foo,nofoo,bar=baz (see nfs(5))</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">options</span>
       </td>
       <td class="descbox">options</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">a translated string with error message, emtpy string if ok</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="StripExtraSlash">local
     <b>StripExtraSlash (string p)
      <span class="a"> -&gt; </span>
      <span class="t">string</span>
     </b>
    </span>
   </div>
   <p>
 Strips a superfluous slash off the end of a pathname.</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">p</span>
       </td>
       <td class="descbox">pathname</td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">stripped pathname</td>
      </tr>
     </table>
    </dd>
   </dl>
   <div class="sigbox">
    <span class="sig" id="IsPortmapperInstalled">local
     <b>IsPortmapperInstalled (string portmapper)
      <span class="a"> -&gt; </span>
      <span class="t">boolean</span>
     </b>
    </span>
   </div>
   <p>
 Check whether pormap is installed, ask user to install it if it is missing</p>
   <dl>
    <dt>
     <b>Parameters:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="p">portmapper</span>
       </td>
       <td class="descbox"></td>
      </tr>
     </table>
    </dd>
   </dl>
   <dl>
    <dt>
     <b>Return value:</b>
    </dt>
    <dd>
     <table>
      <tr>
       <td class="pbox">
        <span class="t" />
       </td>
       <td class="descbox">true if portmap is installed</td>
      </tr>
     </table>
    </dd>
   </dl>
  </div>
  <div class="footer">
   <hr />
   <i>YaST2 Developers Documentation</i>
   <img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
  </div>
 </body>
</html>

ACC SHELL 2018