From f520cbf4d2c7f22490b7b9f86f4947e82c1718c2 Mon Sep 17 00:00:00 2001 From: Markus Armbruster Date: Fri, 6 Feb 2004 23:39:59 +0000 Subject: [PATCH] Document help command. Closes #804550. --- info/Commands/help.t | 38 ++++++++++++++++++++++++++++++++++++++ info/Commands/info.t | 8 ++++++++ 2 files changed, 46 insertions(+) create mode 100644 info/Commands/help.t diff --git a/info/Commands/help.t b/info/Commands/help.t new file mode 100644 index 00000000..93d9fc51 --- /dev/null +++ b/info/Commands/help.t @@ -0,0 +1,38 @@ +.TH Command INFO +.NA info "Provide information on various topics" +.LV Basic +.SY "info []" +.SY "help []" +The Empire info pages are organized by subject. To get a list of +subjects, type: +.EX info +or +.EX help +You can then type: +.EX info Subject +to get a list of Empire commands and info topics which are related +to the Subject that you chose. Note that Subjects always start with a +capital letter (this is to distinguish them from commands which are +always lowercase). +.s1 +To get info on the syntax of an Empire command, type: +.EX info command +where "command" is the command you're interested in. Note that info +about Empire command syntax is always specified lower-case. +.s1 +To get info about some Empire topic, type: +.EX info Topic +Where Topic is the name of some Empire topic that you're interested in. +.s1 +Every Empire command and topic belongs to at least one subject, and in +some cases more than one. +.s1 +.EX info all +This will list all info pages. Warning: this list is long! +.s1 +As of this writing, some clients shanghai the help command to provide +help on their own command line extensions, but fail to integrate +server help. If the help command doesn't work for you, try the info +command instead. +.s1 +.SA "Bugs, Playing" diff --git a/info/Commands/info.t b/info/Commands/info.t index d5d157c1..93d9fc51 100644 --- a/info/Commands/info.t +++ b/info/Commands/info.t @@ -2,9 +2,12 @@ .NA info "Provide information on various topics" .LV Basic .SY "info []" +.SY "help []" The Empire info pages are organized by subject. To get a list of subjects, type: .EX info +or +.EX help You can then type: .EX info Subject to get a list of Empire commands and info topics which are related @@ -27,4 +30,9 @@ some cases more than one. .EX info all This will list all info pages. Warning: this list is long! .s1 +As of this writing, some clients shanghai the help command to provide +help on their own command line extensions, but fail to integrate +server help. If the help command doesn't work for you, try the info +command instead. +.s1 .SA "Bugs, Playing"