[tor-commits] [nyx/master] Nyxrc header and change path

[atagar at torproject.org]

commit a6cc11c9301d115a3f75e0d2f63ced840fcd9a91
Author: Damian Johnson <atagar at torproject.org>
Date:   Thu Nov 10 10:51:16 2016 -0800

    Nyxrc header and change path
    
    Adding a header to explain how the nyxrc is used. Also changing the default
    path where we look for one. ~/.nyxrc would make sense, but since we have a
    ~/.nyx data directory anyway might as well just call ourselves 'config'.
---
 nyx/arguments.py |  2 +-
 nyxrc.sample     | 14 +++++++++++---
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/nyx/arguments.py b/nyx/arguments.py
index efb95ee..09c0003 100644
--- a/nyx/arguments.py
+++ b/nyx/arguments.py
@@ -22,7 +22,7 @@ DEFAULT_ARGS = {
   'user_provided_port': False,
   'control_socket': '/var/run/tor/control',
   'user_provided_socket': False,
-  'config': os.path.join(os.path.expanduser('~/.nyx'), 'nyxrc'),
+  'config': os.path.join(os.path.expanduser('~/.nyx'), 'config'),
   'debug_path': None,
   'logged_events': 'NOTICE,WARN,ERR,NYX_NOTICE,NYX_WARNING,NYX_ERROR',
   'print_version': False,
diff --git a/nyxrc.sample b/nyxrc.sample
index b3c17ed..508c87f 100644
--- a/nyxrc.sample
+++ b/nyxrc.sample
@@ -1,5 +1,13 @@
+# Nyx can be customized through a configuration file with the following
+# options. Values shown below are the default unless marked with a asterisk.
+#
+# Place your configuration at ~/.nyx/config or run with the following to
+# apply the settings...
+#
+#   % nyx --config /path/to/config
+
 data_directory ~/.nyx   # Caching location, can be set to 'disabled'.
-tor_chroot /path        # Chroot jail tor resides within if there is one.
+tor_chroot /path        # Chroot jail tor resides within if there is one. (*)
 show_bytes false        # Bandwidth rate as bytes if true, bits otherwise.
 confirm_quit true       # Confirm before quitting.
 color_interface true    # Uses color in our interface.
@@ -15,8 +23,8 @@ port_usage_rate 5       # Seconds between querying processes using ports.
 logged_events events    # Events that are shown by default in the log. [1]
 deduplicate_log true    # Hides duplicate log messages.
 prepopulate_log true    # Populates with events that occure before we started.
-logging_filter pattern  # Regex filter for log messages that are shown.
-write_logs_to /path     # Writes events that occure while running here.
+logging_filter pattern  # Regex filter for log messages that are shown. (*)
+write_logs_to /path     # Writes events that occure while running here. (*)
 max_log_size 1000       # Maximum number of log entries.
 
 graph_stat bandwidth        # Statistic to be graphed. [2]