aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/calibration.dox
diff options
context:
space:
mode:
authorBen Hilburn <ben.hilburn@ettus.com>2015-02-11 16:28:35 -0800
committerBen Hilburn <ben.hilburn@ettus.com>2015-02-11 16:28:35 -0800
commit08267a8c0264e08fe6631ce2ede0ec2c2933463f (patch)
tree4e65d128fcc7f3888880f54863a2b2831965364a /host/docs/calibration.dox
parentb10c9dd446f0b0567e6b16add0fc8004d465d76e (diff)
downloaduhd-08267a8c0264e08fe6631ce2ede0ec2c2933463f.tar.gz
uhd-08267a8c0264e08fe6631ce2ede0ec2c2933463f.tar.bz2
uhd-08267a8c0264e08fe6631ce2ede0ec2c2933463f.zip
Creating the $UHD_CONFIG_DIR env var, here used for custom cal data storage.
This is a renaming of the previously created $UHDCALIBPATH.
Diffstat (limited to 'host/docs/calibration.dox')
-rw-r--r--host/docs/calibration.dox18
1 files changed, 13 insertions, 5 deletions
diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox
index 603ae22e4..eecb7af5c 100644
--- a/host/docs/calibration.dox
+++ b/host/docs/calibration.dox
@@ -57,15 +57,23 @@ daughterboard's EEPROM: :
\subsection calibration_data Calibration Data
-Calibration files are stored in the user's home/application directory.
-They can easily be moved from machine to another by copying the "cal"
-directory. Re-running a calibration utility will replace the existing
-calibration file. The old calibration file will be renamed so it may be
-recovered by the user.
+By default, calibration files are stored in the user's home/application
+directory:
- **Linux:** `${HOME}/.uhd/cal/`
- **Windows:** `%APPDATA%\.uhd\cal\`
+If you would like to specify a custom directory, you can do so with the
+`$UHD_CONFIG_DIR` environment variable:
+
+- **Custom (any OS):** `${UHD_CONFIG_DIR}/.uhd/cal/`
+
+Calibration files can easily be moved from one machine to another by copying the
+"cal" directory. Re-running a calibration utility will replace the existing
+calibration file. The old calibration file will be renamed so it may be
+recovered by the user.
+
+
\subsection ignore_cal_file Ignoring Calibration Files
At runtime, the user can choose to ignore a daughterboard's calibration file by adding "ignore-cal-file" to the arguments. With the UHD API, it can be done as follows: