]> gitweb.factorcode.org Git - factor.git/blob - basis/editors/acme/acme-docs.factor
editors.acme: fix help-lint
[factor.git] / basis / editors / acme / acme-docs.factor
1 ! Copyright (C) 2020 Fred Alger.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: editors.acme help.markup help.syntax ;
4 IN: editors.acme
5
6 ABOUT: "editors.acme"
7
8 ARTICLE: "editors.acme" "Plan9 acme editor support"
9 "This editor invokes the Plan9 `plumb` command. "
10 "With the default Plan 9 plumbing, this will open acme."
11 $nl
12 "The path to the Plan9 installation is determined by "
13 { $link plan9-path }
14 { $see-also "editor" } ;
15
16 HELP: plan9-path
17 { $values { "path" "a pathname string" } }
18 { $description
19 "Find the local installation of Plan9 from user space."
20 "The " { $link plan9-path } " word will try to locate your Plan9"
21 " installation. In order of preference this word checks:"
22 $nl
23 {
24  $list
25  { "The " { $link plan9-path } " global" }
26  "The PLAN9 environment variable"
27 }
28 $nl
29 "Finally, if neither is available, falls back to "
30 "/usr/local/plan9, the default installation path." } ;