From: Jorge Pereira Date: Tue, 13 Aug 2019 17:51:52 +0000 (-0300) Subject: doc: Convert doc/directories.adoc from markdown to asciidoc (#2878) X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2bae86f697baecd70b59e9b99695e6a4674100f6;p=thirdparty%2Ffreeradius-server.git doc: Convert doc/directories.adoc from markdown to asciidoc (#2878) * doc: Rename doc/directories.{md,adoc} * doc: Convert doc/directories.adoc from markdown to asciidoc --- diff --git a/doc/directories.adoc b/doc/directories.adoc new file mode 100644 index 00000000000..00cfa3dbe1f --- /dev/null +++ b/doc/directories.adoc @@ -0,0 +1,66 @@ += Directories + +The directories in the server source are laid out ad follows: + +== Documentation + +[width="100%",cols="50%,50%",options="header",] +|=== +| Directory | Description +| `doc/` | Various snippets of documentation. +| `doc/introduction/` | Concepts and introduction to FreeRADIUS. +| `doc/raddb/` | HTML versions of the configuration files. +| `doc/source/` | Developer documentation for internal APIs +| `doc/unlang/` | The unlang processing language. +| `doc/upgrade/` | How to upgrade from version 3 to version 4. +| `doc/rfc/` | Copies of the RFC’s. If you have Perl, do a `make` in + that directory, and look at the HTML output. +| `man/` | Unix Manual pages for the server, configuration files, + and associated utilities. +|=== + +== Utility + +[cols=",",options="header",] +|=== +|Directory | Description +| `mibs/` | SNMP Mibs for the server. +| `scripts/` | Sample scripts for startup and maintenance. +|=== + +== Configuration + +[width="100%",cols="50%,50%",options="header",] +|=== +| Directory | Description +| `raddb/` | Sample configuration files for the server. +| `raddb/mods-available` | Module configuration files. +| `raddb/mods-enabled` | Directory containing symlinks to `raddb/mods-available`. + Controls which modules are enabled. +| `raddb/sites-available` | Virtual servers. +| `raddb/sites-enabled` | Directory containing symlinks to `raddb/sites-available`. + Control which virtual servers are enabled. +|=== + +== Packaging + +[cols=",",options="header",] +|=== +|Directory | Description +| `debian/` | Files to build a `freeradius` Debian Linux package. +| `redhat/` | Additional files for a RedHat Linux system. +| `suse/` | Additional files for a SuSE (UnitedLinux) system. +|=== + +== Source + +[cols=",",options="header",] +|=== +|Directory | Description +| `src/` | Source code. +| `src/bin/` | Source code for the daemon and associated utilities. +| `src/lib/` | Source code for various utility libraries. +| `src/include/` | Header files. +| `src/protocols/` | Dynamic frontend plug-in modules. +| `src/modules/` | Dynamic backend plug-in modules. +|=== diff --git a/doc/directories.md b/doc/directories.md deleted file mode 100644 index ad3b9a23786..00000000000 --- a/doc/directories.md +++ /dev/null @@ -1,50 +0,0 @@ -# Directories - -The directories in the server source are laid out ad follows: - -### Documentation - -| Directory | Description -|--- |--- -| `doc/` | Various snippets of documentation -| `doc/introduction/` | Concepts and introduction to FreeRADIUS -| `doc/raddb/` | HTML versions of the configuration files -| `doc/source/` | Developer documentation for internal APIs -| `doc/unlang/` | The unlang processing language -| `doc/upgrade/` | How to upgrade from version 3 to version 4. -| `doc/rfc/` | Copies of the RFC's. If you have Perl, do a 'make' in that directory, and look at the HTML output. -| `man/` | Unix Manual pages for the server, configuration files, and associated utilities. - -### Utility - -| Directory | Description -|--- |--- -| `mibs/` | SNMP Mibs for the server. -| `scripts/` | Sample scripts for startup and maintenance. - -### Configuration - -| Directory | Description -|--- |--- -| `raddb/` | Sample configuration files for the server. -| `raddb/mods-available` | Module configuration files. -| `raddb/mods-enabled` | Directory containing symlinks to raddb/mods-available. Controls which modules are enabled. -| `raddb/sites-available` | Virtual servers. -| `raddb/sites-enabled` | Directory containing symlinks to raddb/sites-available. Control which virtual servers are enabled. - -### Packaging -| Directory | Description -|--- |--- -| `debian/` | Files to build a "freeradius" Debian Linux package. -| `redhat/` | Additional files for a RedHat Linux system. -| `suse/` | Additional files for a SuSE (UnitedLinux) system. - -### Source -| Directory | Description -|--- |--- -| `src/` | Source code -| `src/bin/` | Source code for the daemon and associated utilities. -| `src/lib/` | Source code for various utility libraries. -| `src/include/` | Header files. -| `src/protocols/` | Dynamic frontend plug-in modules. -| `src/modules/` | Dynamic backend plug-in modules.