[tor-commits] [nyx/master] Discuss our nyxrc in the FAQ

[atagar at torproject.org]

commit 01f33401f593ebcee4dfb3b991370d571b2d6c56
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Aug 5 17:12:15 2017 -0700

    Discuss our nyxrc in the FAQ
    
    I'd put good money that just about nobody even knows nyx *can* have a nyxrc. On
    one hand this is a pity, but on the other 98% of users really wouldn't find it
    useful. As such the FAQ is probably the right spot.
---
 setup.py                         |  2 +-
 web/index.html                   | 16 ++++++++++++++++
 nyxrc.sample => web/nyxrc.sample |  0
 3 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index e9a0fa5..f47f915 100644
--- a/setup.py
+++ b/setup.py
@@ -44,7 +44,7 @@ class NyxInstaller(install):
 
     self.install_bin_script('run_nyx', os.path.join(self.install_scripts, 'nyx'))
     self.install_file('man page', 'nyx.1', self.man_page)
-    self.install_file('nyxrc sample', 'nyxrc.sample', self.sample_path)
+    self.install_file('web/nyxrc sample', 'nyxrc.sample', self.sample_path)
 
   def install_bin_script(self, source, dest):
     # Install our bin script. We do this ourselves rather than with the setup()
diff --git a/web/index.html b/web/index.html
index 5c2ab82..a010ed4 100644
--- a/web/index.html
+++ b/web/index.html
@@ -144,6 +144,22 @@
           </div>
         </li>
 
+        <li id="nyxrc">
+          <span>How can I configure Nyx?</span>
+          <div class="answer">
+            <p>Like most terminal applications Nyx can be customized through a configuration file. By default <b>~/.nyx/nyxrc</b>, though you can specify one with <b>nyx --config /path/to/nyxrc</b>.</p>
+            <p>Configurations are a simple series of key/value pairs. For example...</p>
+
+            <pre>
+acs_support false
+color_override blue  # make our UI predominately blue
+logged_events BW, NOTICE, WARN, ERR
+            </pre>
+
+            <p>For available options see <b><a href="nyxrc.sample">our sample nyxrc</a></b>.</p>
+          </div>
+        </li>
+
         <li id="report_bug">
           <span>How can I report a bug?</span>
           <div class="answer">
diff --git a/nyxrc.sample b/web/nyxrc.sample
similarity index 100%
rename from nyxrc.sample
rename to web/nyxrc.sample