From 73b074f121b0ab2ac38336916a60891c4d88d2cb Mon Sep 17 00:00:00 2001 From: Marc Lichtman <marcll@vt.edu> Date: Fri, 2 Nov 2018 00:53:52 -0400 Subject: docs: moved usage manual to wiki docs: first snapshot of wiki's usage manual --- docs/doxygen/other/usage.dox | 45 ++++++++++++++++++++------------------------ 1 file changed, 20 insertions(+), 25 deletions(-) (limited to 'docs/doxygen/other/usage.dox') diff --git a/docs/doxygen/other/usage.dox b/docs/doxygen/other/usage.dox index d0872c0a03..c02b88c3a0 100644 --- a/docs/doxygen/other/usage.dox +++ b/docs/doxygen/other/usage.dox @@ -1,4 +1,4 @@ -# Copyright (C) 2017 Free Software Foundation, Inc. +# Copyright (C) 2018 Free Software Foundation, Inc. # # Permission is granted to copy, distribute and/or modify this document # under the terms of the GNU Free Documentation License, Version 1.3 @@ -9,44 +9,39 @@ /*! \page page_usage Usage Manual -Note: Once built, check out <a href="https://www.gnuradio.org/" target="_blank">gnuradio.org</a> for -more tutorials on using the software system and examples. +Note: The Usage Manual has been moved to the <a href="https://wiki.gnuradio.org" target="_blank">GNU Radio wiki</a>, along with all other documentation that is not specific to a block/class/function/etc. -<b>Getting Started</b> +For viewing offline, snapshots of these wiki pages are periodically exported and stored in gnuradio/docs/usage-manual/ + +Here are links to the various Usage Manual pages (they are also linked on the home page of the wiki): -\li \subpage build_guide - Installation notes, dependencies etc. -\li \subpage page_exploring_gnuradio -\li \subpage page_operating_fg +<b>Getting Started</b> +\li <a href="https://wiki.gnuradio.org/index.php/Handling_Flowgraphs" target="_blank">Handling Flowgraphs</a> +\li <a href="https://wiki.gnuradio.org/index.php/GNURadioCompanion" target="_blank">GNU Radio Companion (GRC)</a> <b>Metadata and Messages</b> -\li \subpage page_pmt -\li \subpage page_metadata -\li \subpage page_msg_passing -\li \subpage page_stream_tags -\li \subpage page_tagged_stream_blocks +\li <a href="https://wiki.gnuradio.org/index.php/Polymorphic_Types_(PMTs)" target="_blank">Polymorphic Types (PMTs)</a> +\li <a href="https://wiki.gnuradio.org/index.php/Metadata_Information" target="_blank">Metadata Information</a> +\li <a href="https://wiki.gnuradio.org/index.php/Message_Passing" target="_blank">Message Passing</a> +\li <a href="https://wiki.gnuradio.org/index.php/Stream_Tags" target="_blank">Stream Tags</a> +\li <a href="https://wiki.gnuradio.org/index.php/Tagged_Stream_Blocks" target="_blank">Tagged Stream Blocks</a> <b>Advanced Development Topics</b> -\li \subpage page_logger -\li \subpage page_perf_counters -\li \subpage page_affinity -\li \subpage page_prefs -\li \subpage page_python_blocks +\li <a href="https://wiki.gnuradio.org/index.php/Logging" target="_blank">Logging</a> +\li <a href="https://wiki.gnuradio.org/index.php/Performance_Counters" target="_blank">Performance Counters</a> +\li <a href="https://wiki.gnuradio.org/index.php/Block_Thread_Affinity_and_Priority" target="_blank">Block Thread Affinity and Priority</a> +\li <a href="https://wiki.gnuradio.org/index.php/Configuration_Files" target="_blank">Configuration Files</a> +\li <a href="https://wiki.gnuradio.org/index.php/Types_of_Blocks" target="_blank">Types of Blocks</a> <b>Signal Processing and Digital Communications</b> -\li \subpage page_pfb -\li \subpage page_ofdm -\li \subpage page_packet_data - -<b>Out-of-tree Modules</b> - -\li \subpage page_oot_config +\li <a href="https://wiki.gnuradio.org/index.php/Polyphase_Filterbanks" target="_blank">Polyphase Filterbanks</a> <b>VOLK</b> -\li \subpage volk_guide - How to incorporate and use VOLK in GNU Radio blocks +\li <a href="https://wiki.gnuradio.org/index.php/VOLK_Guide" target="_blank">VOLK Guide</a> */ -- cgit v1.2.3