aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL.txt
blob: 2669c0c3cdd4db1b618aabde5cd6794eaeadcad3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Dependencies needed, by example of a debian system:

apt-get install \
  make \
  asciidoc \
  xsltproc \
  dblatex \
  mscgen \
  graphviz \
  python-pychart \
  python-nwdiag

Build PDFs, run:
  make
or for a parallel build using more CPU cores:
  make -j 5

To update the VTY reference for a given program, use osmodumpdoc.py, available
from git.osmocom.org/python/osmo-python-tests -- for example, for osmo-msc:

  cd ~/osmo-python-tests
  ./setup.py install

  cd ~/osmo-msc
  mkdir build
  cd build
  ../configure --enable-smpp
  make
  osmodumpdoc.py -p ~/osmo-msc

  cp doc/msc_vty_reference.xml ~/osmo-gsm-manuals/OsmoMSC/vty/
  cd ~/osmo-gsm-manuals/OsmoMSC
  git status
  git diff
  make
  git commit -a -m "OsmoMSC: update VTY reference"
  git push origin HEAD:refs/for/master/msc_vty