doc/index.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
   5 <head>
   6 <!-- 2023-10-12 Thu 22:18 -->
   7 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
   8 <meta name="viewport" content="width=device-width, initial-scale=1" />
   9 <title>CLI Helper - library to help implementing commandline interfaces</title>
  10 <meta name="author" content="Svjatoslav Agejenko" />
  11 <meta name="generator" content="Org Mode" />
  12 <style>
  13   #content { max-width: 60em; margin: auto; }
  14   .title  { text-align: center;
  15              margin-bottom: .2em; }
  16   .subtitle { text-align: center;
  17               font-size: medium;
  18               font-weight: bold;
  19               margin-top:0; }
  20   .todo   { font-family: monospace; color: red; }
  21   .done   { font-family: monospace; color: green; }
  22   .priority { font-family: monospace; color: orange; }
  23   .tag    { background-color: #eee; font-family: monospace;
  24             padding: 2px; font-size: 80%; font-weight: normal; }
  25   .timestamp { color: #bebebe; }
  26   .timestamp-kwd { color: #5f9ea0; }
  27   .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
  28   .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
  29   .org-center { margin-left: auto; margin-right: auto; text-align: center; }
  30   .underline { text-decoration: underline; }
  31   #postamble p, #preamble p { font-size: 90%; margin: .2em; }
  32   p.verse { margin-left: 3%; }
  33   pre {
  34     border: 1px solid #e6e6e6;
  35     border-radius: 3px;
  36     background-color: #f2f2f2;
  37     padding: 8pt;
  38     font-family: monospace;
  39     overflow: auto;
  40     margin: 1.2em;
  41   }
  42   pre.src {
  43     position: relative;
  44     overflow: auto;
  45   }
  46   pre.src:before {
  47     display: none;
  48     position: absolute;
  49     top: -8px;
  50     right: 12px;
  51     padding: 3px;
  52     color: #555;
  53     background-color: #f2f2f299;
  54   }
  55   pre.src:hover:before { display: inline; margin-top: 14px;}
  56   /* Languages per Org manual */
  57   pre.src-asymptote:before { content: 'Asymptote'; }
  58   pre.src-awk:before { content: 'Awk'; }
  59   pre.src-authinfo::before { content: 'Authinfo'; }
  60   pre.src-C:before { content: 'C'; }
  61   /* pre.src-C++ doesn't work in CSS */
  62   pre.src-clojure:before { content: 'Clojure'; }
  63   pre.src-css:before { content: 'CSS'; }
  64   pre.src-D:before { content: 'D'; }
  65   pre.src-ditaa:before { content: 'ditaa'; }
  66   pre.src-dot:before { content: 'Graphviz'; }
  67   pre.src-calc:before { content: 'Emacs Calc'; }
  68   pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
  69   pre.src-fortran:before { content: 'Fortran'; }
  70   pre.src-gnuplot:before { content: 'gnuplot'; }
  71   pre.src-haskell:before { content: 'Haskell'; }
  72   pre.src-hledger:before { content: 'hledger'; }
  73   pre.src-java:before { content: 'Java'; }
  74   pre.src-js:before { content: 'Javascript'; }
  75   pre.src-latex:before { content: 'LaTeX'; }
  76   pre.src-ledger:before { content: 'Ledger'; }
  77   pre.src-lisp:before { content: 'Lisp'; }
  78   pre.src-lilypond:before { content: 'Lilypond'; }
  79   pre.src-lua:before { content: 'Lua'; }
  80   pre.src-matlab:before { content: 'MATLAB'; }
  81   pre.src-mscgen:before { content: 'Mscgen'; }
  82   pre.src-ocaml:before { content: 'Objective Caml'; }
  83   pre.src-octave:before { content: 'Octave'; }
  84   pre.src-org:before { content: 'Org mode'; }
  85   pre.src-oz:before { content: 'OZ'; }
  86   pre.src-plantuml:before { content: 'Plantuml'; }
  87   pre.src-processing:before { content: 'Processing.js'; }
  88   pre.src-python:before { content: 'Python'; }
  89   pre.src-R:before { content: 'R'; }
  90   pre.src-ruby:before { content: 'Ruby'; }
  91   pre.src-sass:before { content: 'Sass'; }
  92   pre.src-scheme:before { content: 'Scheme'; }
  93   pre.src-screen:before { content: 'Gnu Screen'; }
  94   pre.src-sed:before { content: 'Sed'; }
  95   pre.src-sh:before { content: 'shell'; }
  96   pre.src-sql:before { content: 'SQL'; }
  97   pre.src-sqlite:before { content: 'SQLite'; }
  98   /* additional languages in org.el's org-babel-load-languages alist */
  99   pre.src-forth:before { content: 'Forth'; }
 100   pre.src-io:before { content: 'IO'; }
 101   pre.src-J:before { content: 'J'; }
 102   pre.src-makefile:before { content: 'Makefile'; }
 103   pre.src-maxima:before { content: 'Maxima'; }
 104   pre.src-perl:before { content: 'Perl'; }
 105   pre.src-picolisp:before { content: 'Pico Lisp'; }
 106   pre.src-scala:before { content: 'Scala'; }
 107   pre.src-shell:before { content: 'Shell Script'; }
 108   pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
 109   /* additional language identifiers per "defun org-babel-execute"
 110        in ob-*.el */
 111   pre.src-cpp:before  { content: 'C++'; }
 112   pre.src-abc:before  { content: 'ABC'; }
 113   pre.src-coq:before  { content: 'Coq'; }
 114   pre.src-groovy:before  { content: 'Groovy'; }
 115   /* additional language identifiers from org-babel-shell-names in
 116      ob-shell.el: ob-shell is the only babel language using a lambda to put
 117      the execution function name together. */
 118   pre.src-bash:before  { content: 'bash'; }
 119   pre.src-csh:before  { content: 'csh'; }
 120   pre.src-ash:before  { content: 'ash'; }
 121   pre.src-dash:before  { content: 'dash'; }
 122   pre.src-ksh:before  { content: 'ksh'; }
 123   pre.src-mksh:before  { content: 'mksh'; }
 124   pre.src-posh:before  { content: 'posh'; }
 125   /* Additional Emacs modes also supported by the LaTeX listings package */
 126   pre.src-ada:before { content: 'Ada'; }
 127   pre.src-asm:before { content: 'Assembler'; }
 128   pre.src-caml:before { content: 'Caml'; }
 129   pre.src-delphi:before { content: 'Delphi'; }
 130   pre.src-html:before { content: 'HTML'; }
 131   pre.src-idl:before { content: 'IDL'; }
 132   pre.src-mercury:before { content: 'Mercury'; }
 133   pre.src-metapost:before { content: 'MetaPost'; }
 134   pre.src-modula-2:before { content: 'Modula-2'; }
 135   pre.src-pascal:before { content: 'Pascal'; }
 136   pre.src-ps:before { content: 'PostScript'; }
 137   pre.src-prolog:before { content: 'Prolog'; }
 138   pre.src-simula:before { content: 'Simula'; }
 139   pre.src-tcl:before { content: 'tcl'; }
 140   pre.src-tex:before { content: 'TeX'; }
 141   pre.src-plain-tex:before { content: 'Plain TeX'; }
 142   pre.src-verilog:before { content: 'Verilog'; }
 143   pre.src-vhdl:before { content: 'VHDL'; }
 144   pre.src-xml:before { content: 'XML'; }
 145   pre.src-nxml:before { content: 'XML'; }
 146   /* add a generic configuration mode; LaTeX export needs an additional
 147      (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
 148   pre.src-conf:before { content: 'Configuration File'; }
 149
 150   table { border-collapse:collapse; }
 151   caption.t-above { caption-side: top; }
 152   caption.t-bottom { caption-side: bottom; }
 153   td, th { vertical-align:top;  }
 154   th.org-right  { text-align: center;  }
 155   th.org-left   { text-align: center;   }
 156   th.org-center { text-align: center; }
 157   td.org-right  { text-align: right;  }
 158   td.org-left   { text-align: left;   }
 159   td.org-center { text-align: center; }
 160   dt { font-weight: bold; }
 161   .footpara { display: inline; }
 162   .footdef  { margin-bottom: 1em; }
 163   .figure { padding: 1em; }
 164   .figure p { text-align: center; }
 165   .equation-container {
 166     display: table;
 167     text-align: center;
 168     width: 100%;
 169   }
 170   .equation {
 171     vertical-align: middle;
 172   }
 173   .equation-label {
 174     display: table-cell;
 175     text-align: right;
 176     vertical-align: middle;
 177   }
 178   .inlinetask {
 179     padding: 10px;
 180     border: 2px solid gray;
 181     margin: 10px;
 182     background: #ffffcc;
 183   }
 184   #org-div-home-and-up
 185    { text-align: right; font-size: 70%; white-space: nowrap; }
 186   textarea { overflow-x: auto; }
 187   .linenr { font-size: smaller }
 188   .code-highlighted { background-color: #ffff00; }
 189   .org-info-js_info-navigation { border-style: none; }
 190   #org-info-js_console-label
 191     { font-size: 10px; font-weight: bold; white-space: nowrap; }
 192   .org-info-js_search-highlight
 193     { background-color: #ffff00; color: #000000; font-weight: bold; }
 194   .org-svg { }
 195 </style>
 196 <link rel="stylesheet" type="text/css" href="https://thomasf.github.io/solarized-css/solarized-dark.min.css" />
 197 </head>
 198 <body>
 199 <div id="content" class="content">
 200 <h1 class="title">CLI Helper - library to help implementing commandline interfaces</h1>
 201 <div id="table-of-contents" role="doc-toc">
 202 <h2>Table of Contents</h2>
 203 <div id="text-table-of-contents" role="doc-toc">
 204 <ul>
 205 <li><a href="#orgf8634f9">1. General</a>
 206 <ul>
 207 <li><a href="#orgd17f1cf">1.1. Source code</a></li>
 208 </ul>
 209 </li>
 210 <li><a href="#org873ac39">2. Library contents</a>
 211 <ul>
 212 <li><a href="#org7e47dc1">2.1. Ask for user input</a></li>
 213 </ul>
 214 </li>
 215 <li><a href="#orge7ef3ef">3. Getting the library</a></li>
 216 </ul>
 217 </div>
 218 </div>
 219
 220 <div id="outline-container-orgf8634f9" class="outline-2">
 221 <h2 id="orgf8634f9"><span class="section-number-2">1.</span> General</h2>
 222 <div class="outline-text-2" id="text-1">
 223 <ul class="org-ul">
 224 <li>This program is free software: released under Creative Commons Zero
 225 (CC0) license</li>
 226
 227 <li>Program author:
 228 <ul class="org-ul">
 229 <li>Svjatoslav Agejenko</li>
 230 <li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a></li>
 231 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a></li>
 232 </ul></li>
 233
 234 <li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a></li>
 235 </ul>
 236 </div>
 237
 238 <div id="outline-container-orgd17f1cf" class="outline-3">
 239 <h3 id="orgd17f1cf"><span class="section-number-3">1.1.</span> Source code</h3>
 240 <div class="outline-text-3" id="text-1-1">
 241 <ul class="org-ul">
 242 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
 243
 244 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary">Browse Git repository online</a></li>
 245
 246 <li><p>
 247 Clone Git repository using command:
 248 </p>
 249 <pre class="example">
 250 git clone https://www2.svjatoslav.eu/git/cli-helper.git
 251 </pre></li>
 252
 253 <li>See <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">JavaDoc</a></li>
 254 </ul>
 255 </div>
 256 </div>
 257 </div>
 258
 259 <div id="outline-container-org873ac39" class="outline-2">
 260 <h2 id="org873ac39"><span class="section-number-2">2.</span> Library contents</h2>
 261 <div class="outline-text-2" id="text-2">
 262 <ul class="org-ul">
 263 <li>See also: <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">CLI Helper JavaDoc</a>.</li>
 264 </ul>
 265
 266 <p>
 267 This library is a collection of command-line interface (CLI) helper
 268 functions that simplifies the process of building and maintaining CLI
 269 applications. The library provides several different functionalities,
 270 such as:
 271 </p>
 272
 273 <ul class="org-ul">
 274 <li><a href="#org7e47dc1">Asking for user input</a></li>
 275 <li><a href="CLI arguments processing.html#ID-46115263-ed3d-4acc-9ec5-523d7acf87b8">Commandline interface arguments processing</a></li>
 276 </ul>
 277 </div>
 278
 279 <div id="outline-container-org7e47dc1" class="outline-3">
 280 <h3 id="org7e47dc1"><span class="section-number-3">2.1.</span> Ask for user input</h3>
 281 <div class="outline-text-3" id="text-2-1">
 282 <dl class="org-dl">
 283 <dt>askBoolean()</dt><dd>Asks the user to enter a boolean value (yes/no).</dd>
 284 <dt>askLong()</dt><dd>Asks the user to enter an integer.</dd>
 285 <dt>askString()</dt><dd>Asks the user to enter a string.</dd>
 286 </dl>
 287 </div>
 288 </div>
 289 </div>
 290
 291 <div id="outline-container-orge7ef3ef" class="outline-2">
 292 <h2 id="orge7ef3ef"><span class="section-number-2">3.</span> Getting the library</h2>
 293 <div class="outline-text-2" id="text-3">
 294 <p>
 295 Instructions to embed svjatoslav-commons library in your project:
 296 </p>
 297
 298 <p>
 299 Maven pom.xml file snippet:
 300 </p>
 301
 302 <div class="org-src-container">
 303 <pre class="src src-xml">&lt;<span style="color: #89b4fa;">dependencies</span>&gt;
 304     ...
 305     &lt;<span style="color: #89b4fa;">dependency</span>&gt;
 306         &lt;<span style="color: #89b4fa;">groupId</span>&gt;eu.svjatoslav&lt;/<span style="color: #89b4fa;">groupId</span>&gt;
 307         &lt;<span style="color: #89b4fa;">artifactId</span>&gt;cli-helper&lt;/<span style="color: #89b4fa;">artifactId</span>&gt;
 308         &lt;<span style="color: #89b4fa;">version</span>&gt;1.0&lt;/<span style="color: #89b4fa;">version</span>&gt;
 309     &lt;/<span style="color: #89b4fa;">dependency</span>&gt;
 310     ...
 311 &lt;/<span style="color: #89b4fa;">dependencies</span>&gt;
 312
 313
 314 &lt;<span style="color: #89b4fa;">repositories</span>&gt;
 315     ...
 316     &lt;<span style="color: #89b4fa;">repository</span>&gt;
 317         &lt;<span style="color: #89b4fa;">id</span>&gt;svjatoslav.eu&lt;/<span style="color: #89b4fa;">id</span>&gt;
 318         &lt;<span style="color: #89b4fa;">name</span>&gt;Svjatoslav repository&lt;/<span style="color: #89b4fa;">name</span>&gt;
 319         &lt;<span style="color: #89b4fa;">url</span>&gt;http://www3.svjatoslav.eu/maven/&lt;/<span style="color: #89b4fa;">url</span>&gt;
 320     &lt;/<span style="color: #89b4fa;">repository</span>&gt;
 321     ...
 322 &lt;/<span style="color: #89b4fa;">repositories</span>&gt;
 323 </pre>
 324 </div>
 325 </div>
 326 </div>
 327 </div>
 328 <div id="postamble" class="status">
 329 <p class="author">Author: Svjatoslav Agejenko</p>
 330 <p class="date">Created: 2023-10-12 Thu 22:18</p>
 331 <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
 332 </div>
 333 </body>
 334 </html>