LU-930 doc: add lctl-lcfg man pages

[fs/lustre-release.git] / lustre / utils / lctl.c

diff --git a/lustre/utils/lctl.c b/lustre/utils/lctl.c
index 0a13eb5..134e6fe 100644 (file)
--- a/lustre/utils/lctl.c
+++ b/lustre/utils/lctl.c
@@ -126,8 +126,8 @@ command_t cmdlist[] = {
        {"which_nid", jt_ptl_which_nid, 0, "choose a NID\n"
         "usage: which_nid NID [NID...]"},
        {"replace_nids", jt_replace_nids, 0,
-        "replace primary NIDs for a device\n"
-        "usage: replace_nids <device> <nid1>[,nid2,nid3:nid4,nid5:nid6]"},
+        "replace primary NIDs for device (clients/servers must be unmounted)\n"
+        "usage: replace_nids <DEVICE> <NID1>[,NID2,NID3:NID4,NID5:NID6]"},
        {"interface_list", jt_ptl_print_interfaces, 0,
         "print network interface entries\n"
         "usage: interface_list"},
@@ -451,31 +451,35 @@ command_t cmdlist[] = {
         "usage: llog_catlist"},
        {"llog_info", jt_llog_info, 0,
         "print log header information.\n"
-        "usage: llog_info <logname|FID>\n"},
+        "usage: llog_info {LOGNAME|FID}\n"},
        {"llog_print", jt_llog_print, 0,
         "print all effective log records by default, or within given range.\n"
         "With --raw option skipped records are printed as well.\n"
-        "usage: llog_print <logname|FID> [--start <index>] [--end <index>j]\n"
+        "usage: llog_print {LOGNAME|FID} [--start INDEX] [--end INDEX]\n"
         "                  [--raw]\n"},
        {"llog_cancel", jt_llog_cancel, 0,
         "cancel one record in specified log.\n"
-        "usage:llog_cancel <logname|FID> --log_idx <idx>\n"},
+        "usage:llog_cancel {LOGNAME|FID} --log_idx INDEX\n"},
        {"llog_check", jt_llog_check, 0,
         "verify that log content is valid.\n"
-        "usage: llog_check <logname|FID> [--start <index>] [--end <index>j]\n"
+        "usage: llog_check {LOGNAME|FID} [--start INDEX] [--end INDEX]\n"
         "       check all records from index 1 by default."},
        {"llog_remove", jt_llog_remove, 0,
         "remove one log from catalog or plain log, erase it from disk.\n"
-        "usage: llog_remove <logname|FID> [--log_id <id>]"},
-       {"clear_conf", jt_lcfg_clear, 0,
-        "drop unused config logs for a device or filesystem\n"
-        "usage: clear_conf <device|fsname>"},
-       {"fork_lcfg", jt_lcfg_fork, 0,
+        "usage: llog_remove {LOGNAME|FID} [--log_id ID]"},
+       {"lcfg_clear", jt_lcfg_clear, 0,
+        "drop unused config llog records for a device or filesystem.\n"
+        "clients and servers must be unmounted during this operation.\n"
+        "usage: clear_conf {FSNAME|DEVNAME}"},
+       {"clear_conf", jt_lcfg_clear, 0, "alias for 'lcfg_clear'\n"},
+       {"lcfg_fork", jt_lcfg_fork, 0,
         "copy configuration logs for named filesystem with given name\n"
-        "usage: fork_lcfg <fsname> <newname>"},
-       {"erase_lcfg", jt_lcfg_erase, 0,
+        "usage: fork_lcfg FSNAME NEWNAME"},
+       {"fork_lcfg", jt_lcfg_fork, 0, "alias for 'lcfg_fork'\n"},
+       {"lcfg_erase", jt_lcfg_erase, 0,
         "permanently erase configuration logs for the named filesystem\n"
-        "usage: erase_lcfg <fsname>"},
+        "usage: erase_lcfg FSNAME"},
+       {"erase_lcfg", jt_lcfg_erase, 0, "alias for 'lcfg_erase'\n"},
 #endif /* HAVE_SERVER_SUPPORT */
 
        {"==== obsolete (DANGEROUS) ====", NULL, 0, "obsolete (DANGEROUS)"},