aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorAshish Chaudhari <ashish@ettus.com>2015-02-11 16:33:58 -0800
committerAshish Chaudhari <ashish@ettus.com>2015-02-11 16:33:58 -0800
commitec7eedcca8418970e081b4875c2d5c147611025b (patch)
tree6de14c745f93342fd4717c191a62a0478ab9a919 /host/docs
parentac958d47e8c7c4e0ee6a010d3e5a592d392e9206 (diff)
parent08267a8c0264e08fe6631ce2ede0ec2c2933463f (diff)
downloaduhd-ec7eedcca8418970e081b4875c2d5c147611025b.tar.gz
uhd-ec7eedcca8418970e081b4875c2d5c147611025b.tar.bz2
uhd-ec7eedcca8418970e081b4875c2d5c147611025b.zip
Merge branch 'bhilburn/uhdcalibpath' into maint
Diffstat (limited to 'host/docs')
-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: