← Back to branch summary

~ubuntu-branches/ubuntu/wily/afnix/wily

« back to all changes in this revision

Viewing changes to src/clt/axi/doc/client.xml

  • Committer: Bazaar Package Importer
  • Author(s): Anibal Monsalve Salazar
  • Date: 2011-03-16 21:31:18 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20110316213118-gk4k3ez3e5d2huna
Tags: 2.0.0-1
* QA upload.
* New upstream release
* Debian source format is 3.0 (quilt)
* Fix debhelper-but-no-misc-depends
* Fix ancient-standards-version
* Fix package-contains-linda-override
* debhelper compatibility is 7
* Fix dh-clean-k-is-deprecated

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/clt/axi/doc/client.xml
1
 
<?xml version='1.0'?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
 
3
3
<!-- ====================================================================== -->
4
4
<!-- = client.xml                                                         = -->
13
13
<!-- = incidental  or special  damages arising  in any way out of the use = -->
14
14
<!-- = of this software.                                                  = -->
15
15
<!-- ====================================================================== -->
16
 
<!-- = copyright (c) 1999-2007 - amaury darsch                            = -->
 
16
<!-- = copyright (c) 1999-2011 - amaury darsch                            = -->
17
17
<!-- ====================================================================== -->
18
18
 
19
19
<client>
23
23
  <synopsis>axi [options] file [arguments]</synopsis>
24
24
  <!-- options -->
25
25
  <options>
26
 
   <optn>
27
 
    <name>h</name>
28
 
    <p>
29
 
    prints the help message
30
 
    </p>
31
 
   </optn>
32
 
 
33
 
   <optn>
34
 
    <name>v</name>
35
 
    <p>
36
 
    prints the program version
37
 
    </p>
38
 
   </optn>
39
 
 
40
 
   <optn>
41
 
    <name>i</name>
42
 
    <args>path|librarian</args>
43
 
    <p>
44
 
    add a directory or librarian to the resolver path
45
 
    </p>
46
 
   </optn>
47
 
 
48
 
   <optn>
49
 
    <name>f</name>
50
 
    <args>assert</args>
51
 
    <p>
52
 
    enable assertion checking
53
 
    </p>
54
 
   </optn>
55
 
 
56
 
   <optn>
57
 
    <name>f</name>
58
 
    <args>nopath</args>
59
 
    <p>
60
 
    do no set initial path
61
 
    </p>
62
 
   </optn>
 
26
    <optn>
 
27
      <name>h</name>
 
28
      <p>
 
29
        prints the help message
 
30
      </p>
 
31
    </optn>
 
32
 
 
33
    <optn>
 
34
      <name>v</name>
 
35
      <p>
 
36
        prints the program version
 
37
      </p>
 
38
    </optn>
 
39
 
 
40
    <optn>
 
41
      <name>m</name>
 
42
      <p>
 
43
        enable the start module
 
44
      </p>
 
45
    </optn>
 
46
 
 
47
    <optn>
 
48
      <name>i</name>
 
49
      <args>path|librarian</args>
 
50
      <p>
 
51
        add a directory or librarian to the resolver path
 
52
      </p>
 
53
    </optn>
 
54
 
 
55
    <optn>
 
56
      <name>e</name>
 
57
      <args>mode</args>
 
58
      <p>
 
59
        force the encoding mode
 
60
      </p>
 
61
    </optn>
 
62
 
 
63
    <optn>
 
64
      <name>f</name>
 
65
      <args>assert</args>
 
66
      <p>
 
67
        enable assertion checking
 
68
      </p>
 
69
    </optn>
 
70
 
 
71
    <optn>
 
72
      <name>f</name>
 
73
      <args>nopath</args>
 
74
      <p>
 
75
        do not set initial path
 
76
      </p>
 
77
    </optn>
 
78
 
 
79
    <optn>
 
80
      <name>f</name>
 
81
      <args>noseed</args>
 
82
      <p>
 
83
        do not seed the random engine
 
84
      </p>
 
85
    </optn>
 
86
 
 
87
    <optn>
 
88
      <name>f</name>
 
89
      <args>seed</args>
 
90
      <p>
 
91
        seed the random engine
 
92
      </p>
 
93
    </optn>
63
94
  </options>
64
95
 
65
96
  <!-- description -->
67
98
    <title>Description</title>
68
99
    
69
100
    <p>
70
 
    <product>axi</product> invokes the afnix command line
71
 
    interpreter. Without arguments, the interpreter is invoked
72
 
    interactively. With one or several arguments, the first argument
73
 
    is taken as the file to execute. The rest of the command line is
74
 
    the arguments for the file being executed. With the help of the
75
 
    file resolver, a file does not have to have the <extn>.als</extn>
76
 
    or <extn>.axc</extn> extensions.
 
101
      <product>axi</product> invokes the interpreter command line
 
102
      interpreter. Without arguments, the interpreter is invoked
 
103
      interactively. With one or several arguments, the first argument
 
104
      is taken as the file to execute. The rest of the command line is
 
105
      the arguments for the file being executed. With the help of the
 
106
      file resolver, a file does not have to have the <extn>.als</extn>
 
107
      or <extn>.axc</extn> extensions. When using a librarian, an
 
108
      initial module can be automatically loaded with the help of
 
109
      the <option>m</option> option. A double system separator can be used to
 
110
      separate the interpreter options with the program
 
111
      options. Normally, the encoding mode is automatically detected
 
112
      from the running session or from the system environment. However,
 
113
      the <option>e</option> option might be used to overwrite the default
 
114
      settings, especially when an file is based on one of the ISO-8859
 
115
      character set.
77
116
    </p>
78
117
  </remark>
79
118
 
82
121
    <title>Version</title>
83
122
    
84
123
    <p>
85
 
    The current version is the <major/>.<minor/>.<patch/> release.
 
124
      The current version is the <major/>.<minor/>.<patch/> release.
86
125
    </p>
87
126
  </remark>
88
127
 
91
130
    <title>See also</title>
92
131
 
93
132
    <p>
94
 
    <link url="axc.xht">axc</link>,
95
 
    <link url="axd.xht">axd</link>,
96
 
    <link url="axl.xht">axl</link>,
97
 
    <link url="axs.xht">axs</link>
 
133
      <link url="axc.xht">axc</link>,
 
134
      <link url="axd.xht">axd</link>,
 
135
      <link url="axl.xht">axl</link>,
98
136
    </p>
99
137
  </remark>
100
138
 
103
141
    <title>Notes</title>
104
142
 
105
143
    <p>
106
 
    <afnix/> comes with an extensive documentation. The documentation
107
 
    is available <link url="http://www.afnix.org">online</link>
108
 
    or in the <path>doc</path> directory in the form of formated xhtml
109
 
    documents or manual pages. 
 
144
      The distribution comes with an extensive documentation. The
 
145
      documentation is available <link
 
146
      url="http://www.afnix.org">online</link> or in the
 
147
      <path>doc</path> directory in the form of formatted xhtml 
 
148
      documents or manual pages. 
110
149
    </p>
111
150
  </remark>
112
151
 
115
154
    <title>Author</title>
116
155
    
117
156
    <p>
118
 
    The <afnix/> programming language has been devised and implemented by
119
 
    <mail address="amaury@afnix.org">Amaury Darsch</mail>.
 
157
      The writing system has been conceived and implemented by
 
158
      <mail address="amaury@afnix.org">Amaury Darsch</mail>.
120
159
    </p>
121
160
  </remark>
122
161
 
125
164
    <title>History</title>
126
165
    
127
166
    <p>
128
 
    The <afnix/> programming language was originally called the
129
 
    <em>Aleph programming language</em> which has been discontinued on
130
 
    January 2005 when the 1.0.0 version was released. More information
131
 
    is available in the manual collection.
 
167
      The writing system was originally called the
 
168
      <em>Aleph programming language</em> which has been discontinued on
 
169
      January 2005 when the 1.0.0 version was released. More information
 
170
      is available in the manual collection.
132
171
    </p>
133
172
  </remark> 
134
173
</client>