summaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/build.rst2
-rw-r--r--host/docs/dboards.rst4
-rw-r--r--host/docs/general.rst2
-rw-r--r--host/docs/identification.rst2
-rw-r--r--host/docs/images.rst4
-rw-r--r--host/docs/usrp2.rst18
-rw-r--r--host/docs/usrp_e1xx.rst2
7 files changed, 17 insertions, 17 deletions
diff --git a/host/docs/build.rst b/host/docs/build.rst
index c645817ab..063b2b371 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -116,7 +116,7 @@ Generate Makefiles with cmake
Additionally, configuration variables can be passed into cmake via the command line.
The following common-use configuration variables are listed below:
-* For a custom install prefix: -DCMAKE_INSTALL_PREFIX=<prefix>
+* For a custom install prefix: -DCMAKE_INSTALL_PREFIX=<install-path>
* To install libs into lib64: cmake -DLIB_SUFFIX=64
Example usage:
diff --git a/host/docs/dboards.rst b/host/docs/dboards.rst
index 7f205c404..419456df2 100644
--- a/host/docs/dboards.rst
+++ b/host/docs/dboards.rst
@@ -182,7 +182,7 @@ If you lose R193, you can use anything from 0 to 10 ohms there.
With the daughterboard plugged-in, run the following commands:
::
- cd <prefix>/share/uhd/utils
+ cd <install-path>/share/uhd/utils
./usrp_burn_db_eeprom --id=0x000d --unit=RX --args=<args> --slot=<slot>
* <args> are device address arguments (optional if only one USRP is on your machine)
@@ -209,7 +209,7 @@ These are all 0-ohm, so if you lose one, just short across the appropriate pads
With the daughterboard plugged-in, run the following commands:
::
- cd <prefix>/share/uhd/utils
+ cd <install-path>/share/uhd/utils
./usrp_burn_db_eeprom --id=<rx_id> --unit=RX --args=<args> --slot=<slot>
./usrp_burn_db_eeprom --id=<tx_id> --unit=TX --args=<args> --slot=<slot>
diff --git a/host/docs/general.rst b/host/docs/general.rst
index 2894fbf88..73b820c84 100644
--- a/host/docs/general.rst
+++ b/host/docs/general.rst
@@ -52,5 +52,5 @@ Support for dynamically loadable modules
For a module to be loaded at runtime, it must be:
* found in the UHD_MODULE_PATH environment variable,
-* installed into the <prefix>/share/uhd/modules directory,
+* installed into the <install-path>/share/uhd/modules directory,
* or installed into /usr/share/uhd/modules directory (unix only).
diff --git a/host/docs/identification.rst b/host/docs/identification.rst
index 90484744c..deda61531 100644
--- a/host/docs/identification.rst
+++ b/host/docs/identification.rst
@@ -107,7 +107,7 @@ Set a custom name
Run the following commands:
::
- cd <prefix>/share/uhd/utils
+ cd <install-path>/share/uhd/utils
./usrp_burn_mb_eeprom --args=<optional device args> --key=name --val=lab1_xcvr
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/host/docs/images.rst b/host/docs/images.rst
index f5be88a65..adfa6d530 100644
--- a/host/docs/images.rst
+++ b/host/docs/images.rst
@@ -54,8 +54,8 @@ When installing images from an archive, there are two options:
**Option 1:**
Unpack the archive into the UHD installation prefix.
-The UHD will always search <prefix>/share/uhd/images for image files.
-Where <prefix> was set by the CMAKE_INSTALL_PREFIX at configure-time.
+The UHD will always search <install-path>/share/uhd/images for image files.
+Where <install-path> was set by the CMAKE_INSTALL_PREFIX at configure-time.
**Option 2:**
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 912f7d2bd..161170f2c 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -25,11 +25,11 @@ Use the card burner tool (unix)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
- sudo <prefix>/share/uhd/utils/usrp2_card_burner_gui.py
+ sudo <install-path>/share/uhd/utils/usrp2_card_burner_gui.py
-- OR --
- cd <prefix>/share/uhd/utils
+ cd <install-path>/share/uhd/utils
sudo ./usrp2_card_burner.py --dev=/dev/sd<XXX> --fpga=<path_to_fpga_image>
sudo ./usrp2_card_burner.py --dev=/dev/sd<XXX> --fw=<path_to_firmware_image>
@@ -42,7 +42,7 @@ Use the card burner tool (windows)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
- <path_to_python.exe> <prefix>/share/uhd/utils/usrp2_card_burner_gui.py
+ <path_to_python.exe> <install-path>/share/uhd/utils/usrp2_card_burner_gui.py
------------------------------------------------------------------------
@@ -58,11 +58,11 @@ Use the net burner tool (unix)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
- sudo <prefix>/share/uhd/utils/usrp_n2xx_net_burner_gui.py
+ sudo <install-path>/share/uhd/utils/usrp_n2xx_net_burner_gui.py
-- OR --
- cd <prefix>/share/uhd/utils
+ cd <install-path>/share/uhd/utils
./usrp_n2xx_net_burner.py --addr=<ip address> --fw=<path for firmware image>
./usrp_n2xx_net_burner.py --addr=<ip address> --fpga=<path to FPGA image>
@@ -71,7 +71,7 @@ Use the net burner tool (Windows)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
- <path_to_python.exe> <prefix>/share/uhd/utils/usrp_n2xx_net_burner_gui.py
+ <path_to_python.exe> <install-path>/share/uhd/utils/usrp_n2xx_net_burner_gui.py
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Device recovery and bricking
@@ -145,7 +145,7 @@ and the network must be setup properly as described above.
Run the following commands:
::
- cd <prefix>/share/uhd/utils
+ cd <install-path>/share/uhd/utils
./usrp_burn_mb_eeprom --args=<optional device args> --key=ip-addr --val=192.168.10.3
**Method 2 (Linux Only):**
@@ -154,7 +154,7 @@ It uses raw ethernet packets to bypass the IP/UDP layer to communicate with the
Run the following commands:
::
- cd <prefix>/share/uhd/utils
+ cd <install-path>/share/uhd/utils
sudo ./usrp2_recovery.py --ifc=eth0 --new-ip=192.168.10.3
------------------------------------------------------------------------
@@ -343,5 +343,5 @@ Test the PPS input with the following app:
::
- cd <prefix>/share/uhd/examples
+ cd <install-path>/share/uhd/examples
./test_pps_input --args=<args>
diff --git a/host/docs/usrp_e1xx.rst b/host/docs/usrp_e1xx.rst
index ffcd370dd..fb5848bad 100644
--- a/host/docs/usrp_e1xx.rst
+++ b/host/docs/usrp_e1xx.rst
@@ -61,5 +61,5 @@ can talk directly to the clock generator over a SPI interface.
Run the following commands to restore the clock generator to a usable state:
::
- cd <prefix>/share/uhd/usrp_e_utilities
+ cd <install-path>/share/uhd/usrp_e_utilities
./usrp-e-utility --fpga=../images/usrp_e100_pt_fpga.bin --reclk