rfnoc_modtool(1)                 User Commands                rfnoc_modtool(1)

NAME
       rfnoc_modtool - RFNoC OOT module management tool


DESCRIPTION
       Create and manage RFNoC OOT modules.



SYNOPSIS
       rfnoc_modtool [COMMAND] [OPTIONS]


COMMANDS
       Run rfnoc_modtool COMMAND --help for more information on a specific
       command.


       create Create a new RFNoC OOT module.

       add    Add a new block to an existing RFNoC OOT module.


CREATING NEW MODULES
       When running rfnoc_modtool create, a new directory will be created that
       contains the necessary files for a new RFNoC OOT module. This directory
       will only contain boilerplate code, and the user will need to add their
       own blocks to the module.


ADDING BLOCKS
       When running rfnoc_modtool add, a new block will be added to an
       existing RFNoC OOT module.  This requires previously having run
       rfnoc_modtool create to create the module.



EXAMPLES
   Create a new RFNoC OOT module called filter
       rfnoc_modtool create filter


   Add a block called fir to the filter module (this requires having create a
       fir.yml block descriptor file)
       rfnoc_modtool -C ./rfnoc-filter add fir -y rfnoc-
       foo/rfnoc/blocks/fir.yml



SEE ALSO
       UHD documentation: http://files.ettus.com/manual/

       GR-UHD documentation: http://gnuradio.org/doc/doxygen/page_uhd.html

       Other UHD programs:

       rfnoc_image_builder(1)

AUTHOR
       This manual page was written by Martin Braun.

COPYRIGHT
       Copyright (c) 2015-2022 Ettus Research, A National Instruments Brand

       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.

       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.

UHD                                  4.8.0                    rfnoc_modtool(1)