Whamcloud - gitweb
- add templates for manpages.
[fs/lustre-release.git] / lustre / doc / lctl.lyx
1 #LyX 1.2 created this file. For more info see http://www.lyx.org/
2 \lyxformat 220
3 \textclass manpage
4 \language english
5 \inputencoding auto
6 \fontscheme times
7 \graphics default
8 \paperfontsize default
9 \spacing single 
10 \papersize letterpaper
11 \paperpackage a4
12 \use_geometry 0
13 \use_amsmath 0
14 \use_natbib 0
15 \use_numerical_citations 0
16 \paperorientation portrait
17 \secnumdepth 3
18 \tocdepth 3
19 \paragraph_separation skip
20 \defskip medskip
21 \quotes_language english
22 \quotes_times 2
23 \papercolumns 1
24 \papersides 1
25 \paperpagestyle default
26
27 \layout Section
28
29 NAME
30 \layout Standard
31
32 lctl - low level Lustre file system configuration utility
33 \layout Section
34
35 SYNOPSIS
36 \layout Standard
37
38
39 \series bold 
40 lctl 
41 \layout Standard
42
43
44 \series bold 
45 lctl\SpecialChar ~
46 --device\SpecialChar ~
47 <devno> <command\SpecialChar ~
48 [args]>
49 \layout Standard
50
51
52 \series bold 
53 lctl\SpecialChar ~
54 --threads\SpecialChar ~
55 <numthreads>\SpecialChar ~
56 <verbose>\SpecialChar ~
57 <devno>\SpecialChar ~
58 <command [args]>
59 \layout Section
60
61 DESCRIPTION
62 \layout Standard
63
64 The program can be invoked in interactive mode by issuing 
65 \series bold 
66 lctl.
67
68 \series default 
69  After than commands are issued as below.
70 \layout Standard
71
72 For non-interactive single threaded use, one uses the second invocation
73  which runs 
74 \emph on 
75 command
76 \emph default 
77  after connecting to the 
78 \emph on 
79 device.
80
81 \emph default 
82  
83 \layout Description
84
85 --device The device number to be used for the operation.
86  The value of devno is an integer, normally found by calling 
87 \emph on 
88 lctl name2dev 
89 \emph default 
90 on a device name.
91  
92 \layout Description
93
94 --threads How many threads should be forked doing the command specified.
95  The numthreads variable is a strictly positivie integer indicating how
96  many threads should be started.
97  Verbose can take values <XXXX>, 
98 \emph on 
99 devno 
100 \emph default 
101 is used as above.
102 \layout Section
103
104 SUBCOMMANDS
105 \layout Description
106
107 network\SpecialChar ~
108 config
109 \begin_deeper 
110 \layout Description
111
112 network\SpecialChar ~
113 <tcp/elans/myrinet> Indicate what kind of network applies for the
114  configuration commands that follow.
115 \layout Description
116
117 connect\SpecialChar ~
118 [[<hostname>\SpecialChar ~
119 <port>]\SpecialChar ~
120 |\SpecialChar ~
121 <elan\SpecialChar ~
122 id>] 
123 \layout Description
124
125 disconnect 
126 \layout Description
127
128 mynid 
129 \layout Description
130
131 add_uuid 
132 \layout Description
133
134 close_uuid 
135 \layout Description
136
137 del_uuid 
138 \layout Description
139
140 add_route 
141 \layout Description
142
143 del_route 
144 \layout Description
145
146 route_list 
147 \layout Description
148
149 recv_mem 
150 \layout Description
151
152 send_mem 
153 \layout Description
154
155 nagle
156 \end_deeper 
157 \layout Description
158
159 device\SpecialChar ~
160 selection
161 \begin_deeper 
162 \layout Description
163
164 newdev 
165 \layout Description
166
167 name2dev 
168 \layout Description
169
170 device 
171 \layout Description
172
173 device_list
174 \end_deeper 
175 \layout Description
176
177 device\SpecialChar ~
178 config
179 \begin_deeper 
180 \layout Description
181
182 attach 
183 \layout Description
184
185 setup 
186 \layout Description
187
188 cleanup 
189 \layout Description
190
191 detach 
192 \layout Description
193
194 lovconfig 
195 \end_deeper 
196 \layout Description
197
198 device\SpecialChar ~
199 operations
200 \begin_deeper 
201 \layout Description
202
203 probe
204 \layout Description
205
206 close 
207 \layout Description
208
209 getattr 
210 \layout Description
211
212 setattr
213 \layout Description
214
215 create 
216 \layout Description
217
218 destroy
219 \layout Description
220
221 test_getattr
222 \layout Description
223
224 test_brw
225 \layout Description
226
227 test_ldlm
228 \layout Description
229
230 ldlm_regress_start
231 \layout Description
232
233 ldlm_regress_stop
234 \layout Description
235
236 dump_ldlm 
237 \layout Description
238
239 newconn 
240 \end_deeper 
241 \layout Description
242
243 debug
244 \begin_deeper 
245 \layout Description
246
247 debug_kernel 
248 \layout Description
249
250 debug_file 
251 \layout Description
252
253 clear 
254 \layout Description
255
256 mark 
257 \layout Description
258
259 filter 
260 \layout Description
261
262 show 
263 \layout Description
264
265 debug_list\SpecialChar ~
266 modules 
267 \layout Description
268
269 panic
270 \end_deeper 
271 \layout Description
272
273 control
274 \begin_deeper 
275 \layout Description
276
277 help 
278 \layout Description
279
280 exit 
281 \layout Description
282
283 quit 
284 \end_deeper 
285 \layout Section
286
287 EXAMPLES
288 \layout Section
289
290 BUGS
291 \layout Standard
292
293 None are known.
294 \layout Section
295
296 AUTHOR
297 \layout Standard
298
299 Cluster File Systems, Inc.
300  2002 - created
301 \the_end