docs

Carbs Linux Documentation
git clone git://git.carbslinux.org/docs
Log | Files | Refs | Submodules | README

README.md (1160B)


      1 Carbs Linux User Manual
      2 --------------------------------------------------------------------------------
      3 
      4 This is the Carbs Linux documentation written with Emacs Org-mode. It can be
      5 viewed offline by installing the `carbs-docs` package. Distribution tarballs
      6 come with a prebuilt info page and plaintext pages, so neither `emacs` nor
      7 `texinfo` is necessary.
      8 
      9 You can view offline documentation by doing one of the following:
     10 
     11     less /usr/share/doc/carbslinux.txt
     12 
     13 Or:
     14 
     15     info carbslinux
     16 
     17 There are two packages in the repository for viewing info files, `texinfo` and
     18 `info`. The `info` package only comes with the statically linked documentation
     19 reader, so you don't need `perl` to install it.
     20 
     21     cpt-build info carbs-docs
     22 
     23 
     24 To generate info pages from the git repository, you will need to install
     25 `texinfo`. For your convenience, the plaintext and texinfo files are committed
     26 directly on the repository, but those files are generated directly from Emacs.
     27 
     28     git clone git://git.carbslinux.org/docs
     29     cpt-build texinfo && cpt-install texinfo
     30     redo
     31     PREFIX=/usr redo install
     32     install-info /usr/share/info/carbslinux.info /usr/share/info/dir