diff options
author | Martin Braun <martin.braun@ettus.com> | 2021-12-08 10:32:23 +0100 |
---|---|---|
committer | Aaron Rossetto <aaron.rossetto@ni.com> | 2021-12-08 12:05:45 -0800 |
commit | ed7e0f2f977c44ac4329c8f5ba06efe03550a2ec (patch) | |
tree | 506a549c13c5a13c1e50b112949e566d671cdb25 | |
parent | 948a4ccdc5202e31e5e0be9f614c74aab740e95d (diff) | |
download | uhd-ed7e0f2f977c44ac4329c8f5ba06efe03550a2ec.tar.gz uhd-ed7e0f2f977c44ac4329c8f5ba06efe03550a2ec.tar.bz2 uhd-ed7e0f2f977c44ac4329c8f5ba06efe03550a2ec.zip |
docs: Remove obsolete man pages
The man pages for usrp_x3xx_fpga_burner and octoclock_firmware_burner
are obsolete; the corresponding utilities were replaced by
uhd_image_loader many UHD versions ago.
-rw-r--r-- | host/docs/CMakeLists.txt | 2 | ||||
-rw-r--r-- | host/docs/octoclock_firmware_burner.1 | 45 | ||||
-rw-r--r-- | host/docs/usrp_x3xx_fpga_burner.1 | 65 |
3 files changed, 0 insertions, 112 deletions
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index e9b35bdc2..2b91fd4df 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -107,7 +107,6 @@ endif(ENABLE_MANUAL_OR_DOXYGEN) ######################################################################## set(man_page_sources - octoclock_firmware_burner.1 uhd_cal_rx_iq_balance.1 uhd_cal_tx_dc_offset.1 uhd_cal_tx_iq_balance.1 @@ -117,7 +116,6 @@ set(man_page_sources uhd_images_downloader.1 uhd_usrp_probe.1 usrp_n2xx_simple_net_burner.1 - usrp_x3xx_fpga_burner.1 usrp2_card_burner.1 ) diff --git a/host/docs/octoclock_firmware_burner.1 b/host/docs/octoclock_firmware_burner.1 deleted file mode 100644 index 44ff47a85..000000000 --- a/host/docs/octoclock_firmware_burner.1 +++ /dev/null @@ -1,45 +0,0 @@ -.TH "octoclock_firmware_burner" 1 "3.7.1" UHD "User Commands" -.SH NAME -octoclock_firmware_burner - OctoClock Firmware Burner -.SH DESCRIPTION -Burn firmware images onto an Ettus Research OctoClock device over Ethernet. -.SH SYNOPSIS -.B octoclock_firmware_burner [OPTIONS] -.SH OPTIONS -This program works best when only an IP address is specified. -.IP "Device IP Address:" ---addr=\fI"Address"\fR -.IP "This help information:" ---help -.IP "Custom Firmware Filepath:" ---fw-path=\fI"filepath"\fR -.IP "List all OctoClock devices without burning" ---list -.SH EXAMPLES -.SS Selecting a custom firmware path -.sp -octoclock_firmware_burner --addr=192.168.10.3 --fw-path=~/custom_octoclock_image.bin -.ft -.fi -.SH SEE ALSO -UHD documentation: -.B http://files.ettus.com/manual/ -.LP -Other UHD programs: -.sp -uhd_images_downloader(1) usrp2_card_burner(1) usrp_n2xx_simple_net_burner(1) usrp_x3xx_fpga_burner(1) -.SH AUTHOR -This manual page was written by Nicholas Corgan -for the Debian project (but may be used by others). -.SH COPYRIGHT -Copyright (c) 2014 Ettus Research LLC -.LP -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. -.LP -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. diff --git a/host/docs/usrp_x3xx_fpga_burner.1 b/host/docs/usrp_x3xx_fpga_burner.1 deleted file mode 100644 index 6b4e8c322..000000000 --- a/host/docs/usrp_x3xx_fpga_burner.1 +++ /dev/null @@ -1,65 +0,0 @@ -.TH "usrp_x3xx_fpga_burner" 1 "3.7.0" UHD "User Commands" -.SH NAME -usrp_x3xx_fpga_burner - USRP X-Series FPGA Burner -.SH DESCRIPTION -Burn an FPGA image onto a connected USRP X-Series device. The program takes -two main arguments. The first is either an IP address or an NI-RIO resource -to decide the method of loading the FPGA image. The other is either the -type of image to burn, in which case the program will choose the default image -of that type and model, or a custom FPGA image path. -.SH SYNOPSIS -.B usrp_x3xx_fpga_burner [OPTIONS] -.SH OPTIONS -.IP "Device IP Address:" ---addr=\fI"Address"\fR -. IP "Device NI-RIO Resource:" ---resource=\fI"Resource"\fR -. IP "RPC Port:" ---rpc-port=\fI"Port"\fR (default=5444) -. IP "Image Type (1G, HG, or XG):" ---type=\fI"Type"\fR -. IP "Custom FPGA path:" ---fpga-path=\fI"Path"\fR -. IP "Initialize USRP with image currently burned onto device (Ethernet only):" ---configure -. IP "Verify image during Ethernet burn (takes longer):" ---verify -. IP "List connected USRP X-Series devices:" ---list -.IP "This help information:" ---help -.SH EXAMPLES -.SS Burning a 1-Gigabit image over Ethernet -.sp -usrp_x3xx_fpga_burner --addr=192.168.10.2 --type=1G -.SS Burning a Hybrid image over PCIe -usrp_x3xx_fpga_burner --resource=RIO0 --type=HG -.SS Burning a custom FPGA image over Ethernet -usrp_x3xx_fpga_burner --addr=192.168.10.2 --fpga=path="custom_image.bit" -.ft -.fi -.SH SEE ALSO -UHD documentation: -.B http://files.ettus.com/manual/ -.LP -GR-UHD documentation: -.B http://gnuradio.org/doc/doxygen/page_uhd.html -.LP -Other UHD programs: -.sp -uhd_images_downloader(1) usrp2_card_burner(1) usrp_n2xx_simple_net_burner(1) octoclock_firmware_burner(1) -.SH AUTHOR -This manual page was written by Nicholas Corgan -for the Debian project (but may be used by others). -.SH COPYRIGHT -Copyright (c) 2014 Ettus Research LLC -.LP -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. -.LP -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. |