gnu/packages/texinfo.scm

   1 ;;; GNU Guix --- Functional package management for GNU
   2 ;;; Copyright © 2012, 2013, 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org>
   3 ;;; Copyright © 2014, 2016 Eric Bavier <bavier@member.fsf.org>
   4 ;;; Copyright © 2015 Mark H Weaver <mhw@netris.org>
   5 ;;; Copyright © 2017 Efraim Flashner <efraim@flashner.co.il>
   6 ;;;
   7 ;;; This file is part of GNU Guix.
   8 ;;;
   9 ;;; GNU Guix is free software; you can redistribute it and/or modify it
  10 ;;; under the terms of the GNU General Public License as published by
  11 ;;; the Free Software Foundation; either version 3 of the License, or (at
  12 ;;; your option) any later version.
  13 ;;;
  14 ;;; GNU Guix is distributed in the hope that it will be useful, but
  15 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;;; GNU General Public License for more details.
  18 ;;;
  19 ;;; You should have received a copy of the GNU General Public License
  20 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 (define-module (gnu packages texinfo)
  23   #:use-module (guix licenses)
  24   #:use-module (guix packages)
  25   #:use-module (guix download)
  26   #:use-module (guix build-system gnu)
  27   #:use-module (gnu packages)
  28   #:use-module (gnu packages compression)
  29   #:use-module (gnu packages perl)
  30   #:use-module (gnu packages linux)
  31   #:use-module (gnu packages ncurses))
  32
  33 (define-public texinfo
  34   (package
  35     (name "texinfo")
  36     (version "6.5")
  37     (source (origin
  38               (method url-fetch)
  39               (uri (string-append "mirror://gnu/texinfo/texinfo-"
  40                                   version ".tar.xz"))
  41               (sha256
  42                (base32
  43                 "0qjzvbvnv9003xdrcpi3jp7y68j4hq2ciw9frh2hghh698zlnxvp"))))
  44     (build-system gnu-build-system)
  45     (inputs `(("ncurses" ,ncurses)
  46               ("perl" ,perl)))
  47
  48     (native-search-paths
  49      ;; This is the variable used by the standalone Info reader.
  50      (list (search-path-specification
  51             (variable "INFOPATH")
  52             (files '("share/info")))))
  53
  54     (home-page "https://www.gnu.org/software/texinfo/")
  55     (synopsis "The GNU documentation format")
  56     (description
  57      "Texinfo is the official documentation format of the GNU project.  It
  58 uses a single source file using explicit commands to produce a final document
  59 in any of several supported output formats, such as HTML or PDF.  This
  60 package includes both the tools necessary to produce Info documents from
  61 their source and the command-line Info reader.  The emphasis of the language
  62 is on expressing the content semantically, avoiding physical markup commands.")
  63     (license gpl3+)))
  64
  65 (define-public texinfo-5
  66   (package (inherit texinfo)
  67     (version "5.2")
  68     (source (origin
  69               (method url-fetch)
  70               (uri (string-append "mirror://gnu/texinfo/texinfo-"
  71                                   version ".tar.xz"))
  72               (sha256
  73                (base32
  74                 "1njfwh2z34r2c4r0iqa7v24wmjzvsfyz4vplzry8ln3479lfywal"))))
  75     (native-inputs '())))
  76
  77 (define-public texinfo-4
  78   (package (inherit texinfo)
  79     (version "4.13a")
  80     (source (origin
  81               (method url-fetch)
  82               (uri (string-append
  83                     "mirror://gnu/texinfo/texinfo-"
  84                     version
  85                     ".tar.lzma"))
  86               (sha256
  87                (base32
  88                 "1rf9ckpqwixj65bw469i634897xwlgkm5i9g2hv3avl6mv7b0a3d"))))
  89     (native-inputs '())
  90     (inputs `(("ncurses" ,ncurses) ("xz" ,xz)))))
  91
  92 (define-public info-reader
  93   ;; The idea of this package is to have the standalone Info reader without
  94   ;; the dependency on Perl that 'makeinfo' drags.
  95   (package
  96     (inherit texinfo)
  97     (name "info-reader")
  98     (arguments
  99      `(#:disallowed-references ,(assoc-ref (package-inputs texinfo)
 100                                            "perl")
 101
 102        #:modules ((ice-9 ftw) (srfi srfi-1)
 103                   ,@%gnu-build-system-modules)
 104
 105        #:phases (modify-phases %standard-phases
 106                   (add-after 'install 'keep-only-info-reader
 107                     (lambda* (#:key outputs #:allow-other-keys)
 108                       ;; Remove everything but 'bin/info' and associated
 109                       ;; files.
 110                       (define (files)
 111                         (scandir "." (lambda (file)
 112                                        (not (member file '("." ".."))))))
 113
 114                       (let ((out (assoc-ref outputs "out")))
 115                         (with-directory-excursion out
 116                           (for-each delete-file-recursively
 117                                     (fold delete (files) '("bin" "share"))))
 118                         (with-directory-excursion (string-append out "/bin")
 119                           (for-each delete-file (delete "info" (files))))
 120                         (with-directory-excursion (string-append out "/share")
 121                           (for-each delete-file-recursively
 122                                     (fold delete (files)
 123                                           '("info" "locale"))))
 124                         #t))))))
 125     (synopsis "Standalone Info documentation reader")))
 126
 127 (define-public texi2html
 128   (package
 129     (name "texi2html")
 130     (version "5.0")
 131     (source (origin
 132               (method url-fetch)
 133               (uri (string-append "mirror://savannah/" name "/" name "-"
 134                                   version ".tar.bz2"))
 135               (sha256
 136                (base32
 137                 "1yprv64vrlcbksqv25asplnjg07mbq38lfclp1m5lj8cw878pag8"))
 138               (patches
 139                (search-patches "texi2html-document-encoding.patch"
 140                                "texi2html-i18n.patch"))
 141               (snippet
 142                ;; This file is modified by the patch above, but reset its
 143                ;; timestamp so we don't trigger the rule to update PO files,
 144                ;; which would require Gettext.
 145                ;; See <http://bugs.gnu.org/18247>.
 146                '(begin
 147                   (utime "texi2html.pl" 0 0 0 0)
 148                   #t))))
 149     (build-system gnu-build-system)
 150     (inputs `(("perl" ,perl)))
 151     (arguments
 152      ;; Tests fail because of warnings on stderr from Perl 5.22.  Adjusting
 153      ;; texi2html.pl to avoid the warnings seems non-trivial, so we simply
 154      ;; disable the tests.
 155      '(#:tests? #f))
 156     (home-page "https://www.nongnu.org/texi2html/")
 157     (synopsis "Convert Texinfo to HTML")
 158     (description
 159      "Texi2HTML is a Perl script which converts Texinfo source files to HTML
 160 output.  It now supports many advanced features, such as internationalization
 161 and extremely configurable output formats.
 162
 163 Development of Texi2HTML moved to the GNU Texinfo repository in 2010, since it
 164 was meant to replace the makeinfo implementation in GNU Texinfo.  The route
 165 forward for authors is, in most cases, to alter manuals and build processes as
 166 necessary to use the new features of the makeinfo/texi2any implementation of
 167 GNU Texinfo.  The Texi2HTML maintainers (one of whom is the principal author
 168 of the GNU Texinfo implementation) do not intend to make further releases of
 169 Texi2HTML.")
 170     ;; Files in /lib under lgpl2.1+ and x11
 171     (license gpl2+)))