How To Install NaturalDocs on Fedora 34
NaturalDocs is Documentation generator for multiple programming languages
Introduction
In this tutorial we learn how to install NaturalDocs on Fedora 34.
What is NaturalDocs
Natural Docs is an open-source documentation generator for multiple programming languages. You document your code in a natural syntax that reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it.
We can use yum or dnf to install NaturalDocs on Fedora 34. In this tutorial we discuss both methods but you only need to choose one of method to install NaturalDocs.
Install NaturalDocs on Fedora 34 Using dnf
Update yum database with dnf using the following command.
sudo dnf makecache --refresh
The output should look something like this:
Fedora 34 - x86_64 20 kB/s | 6.6 kB 00:00
Fedora 34 openh264 (From Cisco) - x86_64 1.4 kB/s | 989 B 00:00
Fedora Modular 34 - x86_64 68 kB/s | 6.5 kB 00:00
Fedora 34 - x86_64 - Updates 3.5 kB/s | 6.2 kB 00:01
Fedora Modular 34 - x86_64 - Updates 17 kB/s | 5.9 kB 00:00
Metadata cache created.
After updating yum database, We can install NaturalDocs using dnf by running the following command:
sudo dnf -y install NaturalDocs
Install NaturalDocs on Fedora 34 Using yum
Update yum database with yum using the following command.
sudo yum makecache --refresh
The output should look something like this:
Fedora 34 - x86_64 20 kB/s | 6.6 kB 00:00
Fedora 34 openh264 (From Cisco) - x86_64 1.4 kB/s | 989 B 00:00
Fedora Modular 34 - x86_64 68 kB/s | 6.5 kB 00:00
Fedora 34 - x86_64 - Updates 3.5 kB/s | 6.2 kB 00:01
Fedora Modular 34 - x86_64 - Updates 17 kB/s | 5.9 kB 00:00
Metadata cache created.
After updating yum database, We can install NaturalDocs using yum by running the following command:
sudo yum -y install NaturalDocs
How To Uninstall NaturalDocs on Fedora 34
To uninstall only the NaturalDocs package we can use the following command:
sudo dnf remove NaturalDocs
NaturalDocs Package Contents on Fedora 34
/etc/NaturalDocs
/etc/NaturalDocs/Languages.txt
/etc/NaturalDocs/Topics.txt
/usr/bin/NaturalDocs
/usr/share/NaturalDocs
/usr/share/NaturalDocs/Info
/usr/share/NaturalDocs/Info/CSSGuide.txt
/usr/share/NaturalDocs/Info/File Parsing.txt
/usr/share/NaturalDocs/Info/HTMLTestCases.pm
/usr/share/NaturalDocs/Info/Languages.txt
/usr/share/NaturalDocs/Info/NDMarkup.txt
/usr/share/NaturalDocs/Info/Symbol Management.txt
/usr/share/NaturalDocs/Info/images
/usr/share/NaturalDocs/Info/images/Logo.png
/usr/share/NaturalDocs/JavaScript
/usr/share/NaturalDocs/JavaScript/GooglePrettify.js
/usr/share/NaturalDocs/JavaScript/NaturalDocs.js
/usr/share/NaturalDocs/Styles
/usr/share/NaturalDocs/Styles/Default.css
/usr/share/NaturalDocs/Styles/Roman.css
/usr/share/NaturalDocs/Styles/Small.css
/usr/share/doc/NaturalDocs
/usr/share/doc/NaturalDocs/License.txt
/usr/share/doc/NaturalDocs/customizinglanguages.html
/usr/share/doc/NaturalDocs/customizingtopics.html
/usr/share/doc/NaturalDocs/documenting
/usr/share/doc/NaturalDocs/documenting.html
/usr/share/doc/NaturalDocs/documenting/reference.html
/usr/share/doc/NaturalDocs/documenting/walkthrough.html
/usr/share/doc/NaturalDocs/example
/usr/share/doc/NaturalDocs/example/Default.css
/usr/share/doc/NaturalDocs/example/NaturalDocs.js
/usr/share/doc/NaturalDocs/example/Roman.css
/usr/share/doc/NaturalDocs/example/Small.css
/usr/share/doc/NaturalDocs/example/showstyle.html
/usr/share/doc/NaturalDocs/examples.css
/usr/share/doc/NaturalDocs/images
/usr/share/doc/NaturalDocs/images/header
/usr/share/doc/NaturalDocs/images/header/background.png
/usr/share/doc/NaturalDocs/images/header/leftside.png
/usr/share/doc/NaturalDocs/images/header/logo.png
/usr/share/doc/NaturalDocs/images/header/overbody.png
/usr/share/doc/NaturalDocs/images/header/overbodybg.png
/usr/share/doc/NaturalDocs/images/header/overleftmargin.png
/usr/share/doc/NaturalDocs/images/header/overmenu.png
/usr/share/doc/NaturalDocs/images/header/overmenubg.png
/usr/share/doc/NaturalDocs/images/header/rightside.png
/usr/share/doc/NaturalDocs/images/menu
/usr/share/doc/NaturalDocs/images/menu/about.png
/usr/share/doc/NaturalDocs/images/menu/background.png
/usr/share/doc/NaturalDocs/images/menu/bottomleft.png
/usr/share/doc/NaturalDocs/images/menu/bottomright.png
/usr/share/doc/NaturalDocs/images/menu/community.png
/usr/share/doc/NaturalDocs/images/menu/customizing.png
/usr/share/doc/NaturalDocs/images/menu/using.png
/usr/share/doc/NaturalDocs/index.html
/usr/share/doc/NaturalDocs/javascript
/usr/share/doc/NaturalDocs/javascript/BrowserStyles.js
/usr/share/doc/NaturalDocs/javascript/PNGHandling.js
/usr/share/doc/NaturalDocs/keywords.html
/usr/share/doc/NaturalDocs/languages.html
/usr/share/doc/NaturalDocs/menu.html
/usr/share/doc/NaturalDocs/output.html
/usr/share/doc/NaturalDocs/running.html
/usr/share/doc/NaturalDocs/styles.css
/usr/share/doc/NaturalDocs/styles.html
/usr/share/doc/NaturalDocs/troubleshooting.html
/usr/share/perl5/vendor_perl/NaturalDocs
/usr/share/perl5/vendor_perl/NaturalDocs/BinaryFile.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Builder
/usr/share/perl5/vendor_perl/NaturalDocs/Builder.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Builder/Base.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Builder/FramedHTML.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Builder/HTML.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Builder/HTMLBase.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ClassHierarchy
/usr/share/perl5/vendor_perl/NaturalDocs/ClassHierarchy.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ClassHierarchy/Class.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ClassHierarchy/File.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ConfigFile.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Constants.pm
/usr/share/perl5/vendor_perl/NaturalDocs/DefineMembers.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Error.pm
/usr/share/perl5/vendor_perl/NaturalDocs/File.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ImageReferenceTable
/usr/share/perl5/vendor_perl/NaturalDocs/ImageReferenceTable.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ImageReferenceTable/Reference.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ImageReferenceTable/String.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages
/usr/share/perl5/vendor_perl/NaturalDocs/Languages.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/ActionScript.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Ada.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Advanced
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Advanced.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Advanced/Scope.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Advanced/ScopeChange.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Base.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/CSharp.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/PLSQL.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Pascal.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Perl.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Prototype
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Prototype.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Prototype/Parameter.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Simple.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Languages/Tcl.pm
/usr/share/perl5/vendor_perl/NaturalDocs/LineReader.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Menu
/usr/share/perl5/vendor_perl/NaturalDocs/Menu.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Menu/Entry.pm
/usr/share/perl5/vendor_perl/NaturalDocs/NDMarkup.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Parser
/usr/share/perl5/vendor_perl/NaturalDocs/Parser.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Parser/JavaDoc.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Parser/Native.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Parser/ParsedTopic.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Project
/usr/share/perl5/vendor_perl/NaturalDocs/Project.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Project/ImageFile.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Project/SourceFile.pm
/usr/share/perl5/vendor_perl/NaturalDocs/ReferenceString.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Settings
/usr/share/perl5/vendor_perl/NaturalDocs/Settings.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Settings/BuildTarget.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SourceDB
/usr/share/perl5/vendor_perl/NaturalDocs/SourceDB.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SourceDB/Extension.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SourceDB/File.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SourceDB/Item.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SourceDB/ItemDefinition.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SourceDB/WatchedFileDefinitions.pm
/usr/share/perl5/vendor_perl/NaturalDocs/StatusMessage.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolString.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable/File.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable/IndexElement.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable/Reference.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable/ReferenceTarget.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable/Symbol.pm
/usr/share/perl5/vendor_perl/NaturalDocs/SymbolTable/SymbolDefinition.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Topics
/usr/share/perl5/vendor_perl/NaturalDocs/Topics.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Topics/Type.pm
/usr/share/perl5/vendor_perl/NaturalDocs/Version.pm
References
Summary
In this tutorial we learn how to install NaturalDocs on Fedora 34 using yum and dnf.