Whamcloud - gitweb
Some formatting changes were made to these files by doug.
[fs/lustre-release.git] / lustre / doc / lconf.lyx
index 0095c6f..60739c6 100644 (file)
@@ -30,9 +30,9 @@ lconf
 \layout Subsection
 
 NAME
-\layout Standard
+\layout Description
 
-lconf- Lustre file system configuration utility
+lconf Lustre filesystem configuration utility.
 \layout Subsection
 
 SYNOPSIS
@@ -40,6 +40,7 @@ SYNOPSIS
 
 
 \series bold 
+\emph on 
 lconf\SpecialChar ~
 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
  [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
@@ -48,52 +49,137 @@ lconf\SpecialChar ~
 DESCRIPTION
 \layout Standard
 
-This program configures a node following directives in the <XML-config-file>
-\layout Description
+This program configures a node following directives in the <XML-config-file>.
+\layout List
+\labelwidthstring 00.00.0000
+
 
+\series bold 
+\emph on 
 --node\SpecialChar ~
-node_name Specifiy a specific node to configure.
- By default, LCONF will search for nodes with the local hostname and 'localhost'.
- When --node is used, only node_name is searched for.
- If a matching node is not found in the config, then LCONF exits with an
+node_name
+\series default 
+\emph default 
+ Specify a specific node to configure.
+ By default, lconf will search for nodes with the local hostname and 'localhost'.
+ When
+\emph on 
+ --node
+\emph default 
+ is used, only 
+\emph on 
+node_name
+\emph default 
+ is searched for.
+ If a matching node is not found in the config, then lconf exits with an
  error.
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
+
 
---cleanup Unconfigure a node.
- The same config and --node argument used for configuration needs to be
- used for cleanup as well.
- This will attempt to undo all of the configuration steps done by LCONF,
+\series bold 
+\emph on 
+--cleanup
+\series default 
+\emph default 
+ Unconfigure a node.
+ The same config and 
+\emph on 
+--node
+\emph default 
+ argument used for configuration needs to be used for cleanup as well.
+ This will attempt to undo all of the configuration steps done by lconf,
  including unloading the kernel modules.
-\layout Description
+\layout List
+\labelwidthstring 00.00.0000
 
---noexec Print, but don't execute, the steps lconf will perform.
- This is useful for debugging a configuration, and when used with --node,
- can be run on any host.
-\layout Description
 
---gdb Causes LCONF to print a message and pause for 5 seconds after creating
- a gdb module script and before doing any lustre configuration.
- (The gdb module script is always created, however.)
-\layout Description
+\series bold 
+\emph on 
+--noexec
+\series default 
+\emph default 
+ Print, but don't execute, the steps lconf will perform.
+ This is useful for debugging a configuration, and when used with 
+\emph on 
+--node
+\emph default 
+, can be run on any host.
+\layout List
+\labelwidthstring 00.00.0000
 
---nosetup Only load modules, do not configure devices or services
-\layout Description
 
---nomod Only setup devices and services, do not load modules
-\layout Description
+\series bold 
+\emph on 
+--gdb
+\series default 
+\emph default 
+ Causes lconf to print a message and pause for 5 seconds after creating
+ a gdb module script and before doing any Lustre configuration (the gdb
+ module script is always created, however).
+\layout List
+\labelwidthstring 00.00.0000
 
---noexec,-n Don't do anything, but print what would happen.
-\layout Description
 
---verbose,-v Be verbose and show actions while going along
-\layout Description
+\series bold 
+\emph on 
+--nosetup
+\series default 
+\emph default 
+ Only load modules, do not configure devices or services.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold 
+\emph on 
+--nomod
+\series default 
+\emph default 
+ Only setup devices and services, do not load modules.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold 
+\emph on 
+--noexec,-n
+\emph default 
+\series default 
+Don't do anything, but print what would happen.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold 
+\emph on 
+--verbose,-v
+\series default 
+\emph default 
+ Be verbose and show actions while going along.
+\layout List
+\labelwidthstring 00.00.0000
+
+
+\series bold 
+\emph on 
+-h,--help
+\series default 
+\emph default 
+ Print help.
+\layout List
+\labelwidthstring 00.00.0000
 
--h,--help Print help.
-\layout Description
 
+\series bold 
+\emph on 
 --maxlevel\SpecialChar ~
-<level> [NOT IMPLEMENTED] Perform configuration of devices and
- services up to level given.
+<level>
+\series default 
+\emph default 
+ [NOT IMPLEMENTED] Perform configuration of devices and services up to level
+ given.
  
 \emph on 
 level
@@ -103,31 +189,26 @@ level
 net, dev, svc, fs.
  
 \series default 
-When used in conjunction with cleanup services are torn down up to a certain
+When used in conjunction with cleanup, services are torn down up to a certain
  level.
 \layout Subsection
 
 EXAMPLES
 \layout Standard
 
-On client nodes this is typically invoked as 
+On client nodes this is typically invoked as: 
 \layout LyX-Code
 
+
+\size small 
 lconf --node client config.xml
 \layout Standard
 
-in order to give clients, regardless of hostname a single configuration.
+in order to give clients, regardless of hostname, a single configuration.
 \layout Subsection
 
 BUGS
 \layout Standard
 
 None are known.
-\layout Subsection
-
-AUTHOR
-\layout Standard
-
-Cluster File Systems, Inc.
- 2002 - created
 \the_end