How To Install robodoc on Fedora 34

robodoc is Extract documentation from source code

Introduction

In this tutorial we learn how to install robodoc on Fedora 34.

What is robodoc

ROBODoc is a documentation tool (based on the AutoDocs program written a long time ago by Commodore). It extracts specially formatted comment headers from the source file and puts them in a separate file. ROBODoc thus allows you to include the program documentation in the source code and avoid having to maintain two separate documents. ROBODoc can format the documentation in HTML, ASCII, AmigaGuide, LaTeX, or RTF format. It is even possible to include parts of the source code with function names that point their the documentation. It also can create index tables for all your variables, classes, functions, etc. The best feature of ROBODoc is that it works with many languages Assembler, C, Perl, LISP, Occam, Tcl/Tk, Pascal, Fortran, shell scripts, and COBOL, basically any language that supports comments/remarks.

We can use yum or dnf to install robodoc on Fedora 34. In this tutorial we discuss both methods but you only need to choose one of method to install robodoc.

Install robodoc 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 robodoc using dnf by running the following command:

sudo dnf -y install robodoc

Install robodoc 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 robodoc using yum by running the following command:

sudo yum -y install robodoc

How To Uninstall robodoc on Fedora 34

To uninstall only the robodoc package we can use the following command:

sudo dnf remove robodoc

robodoc Package Contents on Fedora 34

/usr/bin/robodoc
/usr/bin/robohdrs
/usr/lib/.build-id
/usr/lib/.build-id/8b
/usr/lib/.build-id/8b/d3b5d50584d9482f90bbea6899007ff5eafb4f
/usr/lib/.build-id/c5
/usr/lib/.build-id/c5/f74fdbbad51dcf90617bf937fc67498cd5dc49
/usr/share/doc/robodoc
/usr/share/doc/robodoc/AUTHORS
/usr/share/doc/robodoc/COPYING
/usr/share/doc/robodoc/ChangeLog
/usr/share/doc/robodoc/Examples
/usr/share/doc/robodoc/Examples/PerlExample
/usr/share/doc/robodoc/Examples/PerlExample/Source
/usr/share/doc/robodoc/Examples/PerlExample/Source/Box
/usr/share/doc/robodoc/Examples/PerlExample/Source/Box.pm
/usr/share/doc/robodoc/Examples/PerlExample/Source/Box/RectangularBox.pm
/usr/share/doc/robodoc/Examples/PerlExample/Source/Box/SquareBox.pm
/usr/share/doc/robodoc/Examples/PerlExample/Source/Cargo.txt
/usr/share/doc/robodoc/Examples/PerlExample/Source/Loader.txt
/usr/share/doc/robodoc/Examples/PerlExample/Source/SmartLoader.pm
/usr/share/doc/robodoc/Examples/PerlExample/Source/TruckPacker.pl
/usr/share/doc/robodoc/Examples/PerlExample/robodoc.rc
/usr/share/doc/robodoc/README
/usr/share/doc/robodoc/manual.css
/usr/share/doc/robodoc/manual.html
/usr/share/man/man1/robodoc.1.gz
/usr/share/man/man1/robohdrs.1.gz

References

Summary

In this tutorial we learn how to install robodoc on Fedora 34 using yum and dnf.