doc.am

   1 # GNU Guix --- Functional package management for GNU
   2 # Copyright © 2012, 2013, 2014, 2015 Ludovic Courtès <ludo@gnu.org>
   3 # Copyright © 2013 Andreas Enge <andreas@enge.fr>
   4 #
   5 # This file is part of GNU Guix.
   6 #
   7 # GNU Guix is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or (at
  10 # your option) any later version.
  11 #
  12 # GNU Guix is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 info_TEXINFOS = doc/guix.texi
  21 EXTRA_DIST +=                                   \
  22   doc/contributing.texi                         \
  23   doc/emacs.texi                                \
  24   doc/fdl-1.3.texi                              \
  25   doc/images/bootstrap-graph.dot                \
  26   doc/images/bootstrap-graph.eps                \
  27   doc/images/bootstrap-graph.pdf                \
  28   doc/environment-gdb.scm
  29
  30 OS_CONFIG_EXAMPLES_TEXI =                       \
  31   doc/os-config-bare-bones.texi                 \
  32   doc/os-config-desktop.texi
  33
  34 # Bundle this file so that makeinfo finds it in out-of-source-tree builds.
  35 BUILT_SOURCES        += $(OS_CONFIG_EXAMPLES_TEXI)
  36 EXTRA_DIST           += $(OS_CONFIG_EXAMPLES_TEXI)
  37 MAINTAINERCLEANFILES  = $(OS_CONFIG_EXAMPLES_TEXI)
  38
  39 doc/os-config-%.texi: gnu/system/examples/%.tmpl
  40         $(MKDIR_P) "`dirname "$@"`"
  41         cp "$<" "$@"
  42
  43 infoimagedir = $(infodir)/images
  44 dist_infoimage_DATA =                           \
  45   doc/images/bootstrap-graph.png                \
  46   doc/images/coreutils-size-map.png
  47
  48 # Try hard to obtain an image size and aspect that's reasonable for inclusion
  49 # in an Info or PDF document.
  50 DOT_OPTIONS =                                   \
  51   -Gratio=.9 -Gnodesep=.005 -Granksep=.00005    \
  52   -Nfontsize=9 -Nheight=.1 -Nwidth=.1
  53
  54 .dot.png:
  55         $(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$@.tmp"
  56         mv "$@.tmp" "$@"
  57
  58 .dot.pdf:
  59         $(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$@.tmp"
  60         mv "$@.tmp" "$@"
  61
  62 .dot.eps:
  63         $(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$@.tmp"
  64         mv "$@.tmp" "$@"
  65
  66 # We cannot add new dependencies to `doc/guix.pdf' & co. (info "(automake)
  67 # Extending").  Using the `-local' rules is imperfect, because they may be
  68 # triggered after the main rule.  Oh, well.
  69 pdf-local: $(top_srcdir)/doc/images/bootstrap-graph.pdf
  70 info-local: $(top_srcdir)/doc/images/bootstrap-graph.png
  71 ps-local: $(top_srcdir)/doc/images/bootstrap-graph.eps
  72
  73 \f
  74 # Manual pages.
  75
  76 doc/guix.1: scripts/guix
  77         -LANGUAGE= $(top_builddir)/pre-inst-env \
  78           $(HELP2MAN) --output="$@" guix
  79
  80 doc/guix-daemon.1: guix-daemon
  81         -LANGUAGE= $(top_builddir)/pre-inst-env \
  82           $(HELP2MAN) --output="$@" guix-daemon
  83
  84 define subcommand-manual-target
  85
  86 doc/guix-$(1).1: scripts/guix guix/scripts/$(1).go
  87         -LANGUAGE= $(top_builddir)/pre-inst-env         \
  88           $(HELP2MAN) --output="$$@" "guix $(1)"
  89
  90 endef
  91
  92 SUBCOMMANDS :=                                  \
  93   archive                                       \
  94   build                                         \
  95   download                                      \
  96   edit                                          \
  97   environment                                   \
  98   gc                                            \
  99   hash                                          \
 100   import                                        \
 101   lint                                          \
 102   package                                       \
 103   publish                                       \
 104   pull                                          \
 105   refresh                                       \
 106   size                                          \
 107   system
 108
 109 $(eval $(foreach subcommand,$(SUBCOMMANDS),                     \
 110           $(call subcommand-manual-target,$(subcommand))))
 111
 112 dist_man1_MANS =                                \
 113   doc/guix.1                                    \
 114   $(SUBCOMMANDS:%=doc/guix-%.1)
 115
 116 if BUILD_DAEMON
 117
 118 dist_man1_MANS +=                               \
 119   doc/guix-daemon.1
 120
 121 endif