From 0b3d00e508ddb6734f8852d728410159a2fcca5a Mon Sep 17 00:00:00 2001
From: Tom Rondeau <tom@trondeau.com>
Date: Fri, 7 Mar 2014 16:21:53 -0500
Subject: runtime: updates prefs to preserve format of preference file options
that are in quotes.
---
docs/doxygen/other/main_page.dox | 33 ++++++++++++++++++++++-----------
1 file changed, 22 insertions(+), 11 deletions(-)
(limited to 'docs/doxygen')
diff --git a/docs/doxygen/other/main_page.dox b/docs/doxygen/other/main_page.dox
index e2956384f6..dde7610974 100644
--- a/docs/doxygen/other/main_page.dox
+++ b/docs/doxygen/other/main_page.dox
@@ -80,20 +80,20 @@ them.
\code
from gnuradio import gr, filter, analog
-
+
class my_topblock(gr.top_block):
def __init__(self):
gr.top_block.__init__(self)
-
+
amp = 1
taps = filter.firdes.low_pass(1, 1, 0.1, 0.01)
-
+
self.src = analog.noise_source_c(gr.GR_GAUSSIAN, amp)
self.flt = filter.fir_filter_ccf(1, taps)
self.snk = blocks.null_sink(gr.sizeof_gr_complex)
-
+
self.connect(self.src, self.flt, self.snk)
-
+
if __name__ == "__main__":
tb = my_topblock()
tb.start()
@@ -160,7 +160,7 @@ In some situations, you might actually want to restrict the size of
the buffer itself. This can help to prevent a buffer who is blocked
for data from just increasing the amount of items in its buffer, which
will then cause an increased latency for new samples. You can set the
-size of an output buffer for each output port for every block.
+size of an output buffer for each output port for every block.
WARNING: This is an advanced feature in GNU Radio and should not be
used without a full understanding of this concept as explained below.
@@ -305,7 +305,7 @@ def main():
tb.src1.set_max_noutput_items(2000)
tb.start(100)
time.sleep(0.01)
-
+
# Stop flowgraph and disconnect the add block
tb.lock()
@@ -356,7 +356,7 @@ The configuration files use the following format:
\code
# Stuff from section 1
[section1]
-var1 = value1
+var1 = value1
var2 = value2 # value of 2
# Stuff from section 2
@@ -368,9 +368,20 @@ In this file, the hash mark ('#') indicates a comment and blank lines
are ignored. Section labels are defined inside square brackets as a
group distinguisher. All options must be associated with a section
name. The options are listed one per line with the option name is
-given followed by an equals ('=') sign and then the value. All section
-and option names must not have white spaces (actually, all white
-spaces are ignored).
+given followed by an equals ('=') sign and then the value.
+
+All section and option names must not have white spaces. If a value
+must have white space, the it MUST be put inside quotes. Any quoted
+value will have its white space preserved and the quotes internally
+will be stripped. As an example, on Apple desktops, an output device
+of "Display Audio" is a possible output device and can be set as:
+
+\code
+[audio_osx]
+default_output_device = "Display Audio"
+\endcode
+
+The result will pass Display Audio to the audio setup.
The value of an option can be a string or number and retrieved through
a few different interfaces. There is a single preference object
--
cgit v1.2.3