doc: Fixed a few typos on Building Doc's, Changed Tab's to spaces and limited line...

[mirror_frr.git] / doc / Building_FRR_on_Ubuntu1404.md

diff --git a/doc/Building_FRR_on_Ubuntu1404.md b/doc/Building_FRR_on_Ubuntu1404.md
index 3198428596ec969afb063c46ce1a493f474b0f86..ac0a45acdfcaa5a7c85c60529ecdff7942562804 100644 (file)
--- a/doc/Building_FRR_on_Ubuntu1404.md
+++ b/doc/Building_FRR_on_Ubuntu1404.md
@@ -8,81 +8,87 @@ Building FRR on Ubuntu 14.04LTS from Git Source
 
 Install required packages
 -------------------------
-               
+        
 Add packages:
 
-       apt-get install git autoconf automake libtool make gawk libreadline-dev texinfo \
-       dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex python-pytest
-               
+    apt-get install git autoconf automake libtool make gawk libreadline-dev \
+       texinfo dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex \
+       python-pytest
+
 Get FRR, compile it and install it (from Git)
 ---------------------------------------------
 
+**This assumes you want to build and install FRR from source and not using
+any packages**
+
 ### Add frr groups and user
 
-       sudo groupadd -g 92 frr
-       sudo groupadd -r -g 85 frrvty
-       sudo adduser --system --ingroup frr --groups frrvty --home /var/run/frr/ \
+    sudo groupadd -g 92 frr
+    sudo groupadd -r -g 85 frrvty
+    sudo adduser --system --ingroup frr --groups frrvty --home /var/run/frr/ \
        --gecos "FRR suite" --shell /sbin/nologin frr
 
 ### Download Source, configure and compile it
-(You may prefer different options on configure statement. These are just an example.)
-
-       git clone https://github.com/freerangerouting/frr.git frr
-       cd frr
-       git checkout stable/2.0
-       ./bootstrap.sh
-       ./configure \
-               --enable-exampledir=/usr/share/doc/frr/examples/ \
-               --localstatedir=/var/run/frr \
-               --sbindir=/usr/lib/frr \
-               --sysconfdir=/etc/frr \
-               --enable-pimd \
-               --enable-watchfrr \
-               --enable-ospfclient=yes \
-               --enable-ospfapi=yes \
-               --enable-multipath=64 \
-               --enable-user=frr \
-               --enable-group=frr \
-               --enable-vty-group=frrvty \
-               --enable-configfile-mask=0640 \
-               --enable-logfile-mask=0640 \
-               --enable-rtadv \
-               --enable-tcp-zebra \
-               --enable-fpm \
-       --with-pkg-git-version \
-               --with-pkg-extra-version=-MyOwnFRRVersion       
-       make
-       make check
-       sudo make install
+(You may prefer different options on configure statement. These are just 
+an example.)
+
+    git clone https://github.com/freerangerouting/frr.git frr
+    cd frr
+    git checkout stable/2.0
+    ./bootstrap.sh
+    ./configure \
+        --enable-exampledir=/usr/share/doc/frr/examples/ \
+        --localstatedir=/var/run/frr \
+        --sbindir=/usr/lib/frr \
+        --sysconfdir=/etc/frr \
+        --enable-pimd \
+        --enable-watchfrr \
+        --enable-ospfclient=yes \
+        --enable-ospfapi=yes \
+        --enable-multipath=64 \
+        --enable-user=frr \
+        --enable-group=frr \
+        --enable-vty-group=frrvty \
+        --enable-configfile-mask=0640 \
+        --enable-logfile-mask=0640 \
+        --enable-rtadv \
+        --enable-tcp-zebra \
+        --enable-fpm \
+        --with-pkg-git-version \
+        --with-pkg-extra-version=-MyOwnFRRVersion   
+    make
+    make check
+    sudo make install
 
 ### Create empty FRR configuration files
 
-       sudo mkdir /var/log/frr
-       sudo chown frr:fee /var/log/frr
-       sudo mkdir /etc/frr
-       sudo touch /etc/frr/etc/zebra.conf
-       sudo touch /etc/frr/etc/bgpd.conf
-       sudo touch /etc/frr/etc/ospfd.conf
-       sudo touch /etc/frr/etc/ospf6d.conf
-       sudo touch /etc/frr/etc/isisd.conf
-       sudo touch /etc/frr/etc/ripd.conf
-       sudo touch /etc/frr/etc/ripngd.conf
-       sudo touch /etc/frr/etc/pimd.conf
-       sudo chown frr:frr /etc/frr/
-       sudo touch /etc/frr/etc/vtysh.conf
-       sudo chown frr:frrvty /etc/frr/etc/vtysh.conf
-       sudo chmod 640 /etc/frr/*.conf
+    sudo mkdir /var/log/frr
+    sudo chown frr:fee /var/log/frr
+    sudo mkdir /etc/frr
+    sudo touch /etc/frr/etc/zebra.conf
+    sudo touch /etc/frr/etc/bgpd.conf
+    sudo touch /etc/frr/etc/ospfd.conf
+    sudo touch /etc/frr/etc/ospf6d.conf
+    sudo touch /etc/frr/etc/isisd.conf
+    sudo touch /etc/frr/etc/ripd.conf
+    sudo touch /etc/frr/etc/ripngd.conf
+    sudo touch /etc/frr/etc/pimd.conf
+    sudo chown frr:frr /etc/frr/
+    sudo touch /etc/frr/etc/vtysh.conf
+    sudo chown frr:frrvty /etc/frr/etc/vtysh.conf
+    sudo chmod 640 /etc/frr/*.conf
 
 ### Enable IP & IPv6 forwarding
 
-Edit `/etc/sysctl.conf` and uncomment the following values (ignore the other settings)
+Edit `/etc/sysctl.conf` and uncomment the following values (ignore the 
+other settings)
 
-       # Uncomment the next line to enable packet forwarding for IPv4
-       net.ipv4.ip_forward=1
+    # Uncomment the next line to enable packet forwarding for IPv4
+    net.ipv4.ip_forward=1
 
-       # Uncomment the next line to enable packet forwarding for IPv6
-       #  Enabling this option disables Stateless Address Autoconfiguration
-       #  based on Router Advertisements for this host
-       net.ipv6.conf.all.forwarding=1
+    # Uncomment the next line to enable packet forwarding for IPv6
+    #  Enabling this option disables Stateless Address Autoconfiguration
+    #  based on Router Advertisements for this host
+    net.ipv6.conf.all.forwarding=1
 
 **Reboot** or use `sysctl` to apply the same config to the running system