Project

General

Profile

Osmocom Manuals

Osmocom cellular infrastructure projects provide a set of manuals, including:
  • User Manuals
  • VTY Reference Manuals
  • Protocol / Interface Manuals

The latest versions of the Osmocom GSM Manuals can always be found at

https://ftp.osmocom.org/docs/latest/

There also is some browsable API Documentation (currently not generated for all libraries).

Contributing

Contributions are most welcome via Gerrit.

If the manual for the program of your particular interest area is missing or you find it incomplete, we kindly ask you for your contribution in form of patches against http://git.osmocom.org/osmo-gsm-manuals/ (or, alternatively Funding)

Building from source

Osmocom User Manuals are available in asciidoc format, maintained in the doc/manuals dir of each Osmocom project and can be built with ./configure --enable-manuals. Shared content is in osmo-gsm-manuals.git. See INSTALL.txt for further instructions.

Troubleshooting: Failed to load external entity

Note that docbook.org since recently are providing DTDs only on HTTPS URLs, while xmllint is incapable of SSL. Hence it is necessary to locally install the docbook DTDs. (On Debian, these are included in the docbook5-xml package.)
On other distributions (such as Arch Linux), there seems to be no package correctly installing the local docbook DTDs, and building will fail with:

warning: failed to load external entity "http://docbook.org/xml/5.0/dtd/docbook.dtd" 
validity error : Could not load the external subset "http://docbook.org/xml/5.0/dtd/docbook.dtd" 

In order to get stuff build, simply modify osmo-gsm-manuals.git's Makefile include to bypass xmllint call:

diff --git a/build/Makefile.docbook.inc b/build/Makefile.docbook.inc
index 373db7d..668796c 100644
--- a/build/Makefile.docbook.inc
+++ b/build/Makefile.docbook.inc
@@ -33,7 +33,6 @@ all: $(DOCBOOKS_PDF)

 # Create a PDF file and lint it before
 # xslt path: find includes in both $(OSMO_GSM_MANUALS_DIR)/common/chapters and $(builddir)/generated
-%.pdf: %.xml %.xml-lint $(DOCBOOKS_DEPS) build common
+%.pdf: %.xml $(DOCBOOKS_DEPS) build common
        dblatex --xslt-opts="--path $(realpath $(OSMO_GSM_MANUALS_DIR))/common/chapters:$$PWD/generated" \
                $(dblatex_quiet) -P draft.mode=no -o $(notdir $@) $<

Add picture from clipboard (Maximum size: 48.8 MB)