doc/click.texi

   1 \input texinfo
   2 @c -*-texinfo-*-
   3
   4 @c %**start of header
   5 @setfilename click.info
   6 @documentencoding UTF-8
   7 @settitle Click Reference Manual
   8 @c %**end of header
   9
  10 @include version.texi
  11
  12 @copying
  13 Copyright @copyright{} 2021 Javier Sancho@*
  14
  15 Permission is granted to copy, distribute and/or modify this document
  16 under the terms of the GNU Free Documentation License, Version 1.3 or
  17 any later version published by the Free Software Foundation; with no
  18 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
  19 copy of the license is included in the section entitled ``GNU Free
  20 Documentation License''.
  21 @end copying
  22
  23 @dircategory Web development
  24 @direntry
  25 * Click: (click).       Click, Command Line Interface Creation Kit for GNU Guile.
  26 @end direntry
  27
  28 @titlepage
  29 @title Click Reference Manual
  30 @subtitle Using Click
  31 @author The Click Developers
  32
  33 @page
  34 @vskip 0pt plus 1filll
  35 Edition @value{EDITION} @*
  36 @value{UPDATED} @*
  37
  38 @insertcopying
  39 @end titlepage
  40
  41 @contents
  42
  43 @node Top
  44 @top Click
  45
  46 This document describes Click version @value{VERSION}, a command line
  47 interface creation kit for GNU Guile.
  48
  49 @menu
  50 * Introduction::                About Click.
  51 * Installation::                Installing Click.
  52 * Tutorial::                    How to get started quickly.
  53 * Contributing::                How to contribute to Click.
  54
  55 * GNU Free Documentation License::  The license of this manual.
  56 * Concept Index::               Concepts.
  57 * Programming Index::           Data types, procedures, syntax, and variables.
  58
  59 @detailmenu
  60  --- The Detailed Node Listing ---
  61
  62 Installation
  63
  64 * Downloading::                 Downloading the source code.
  65 * Requirements::                Software needed to build and run Click.
  66 * Building::                    Building from source code.
  67
  68 @end detailmenu
  69 @end menu
  70
  71 @node Introduction
  72 @chapter Introduction
  73
  74 Introduction to Click
  75
  76 @node Installation
  77 @chapter Installation
  78
  79 @menu
  80 * Downloading::                 Downloading the source code.
  81 * Requirements::                Software needed to build and run Click.
  82 * Building::                    Building from source code.
  83 @end menu
  84
  85 @node Downloading
  86 @section Downloading
  87
  88 Official Click source code release tarballs can be found under Releases
  89 in @url{https://gitlab.com/jsancho/click, Click's website},
  90 along with their associated checksums.
  91
  92 @node Requirements
  93 @section Requirements
  94
  95 Click depends on the following packages:
  96
  97 @itemize
  98 @item
  99 @url{https://gnu.org/software/guile, GNU Guile} version 2.0.11 or
 100 later
 101 @end itemize
 102
 103 @node Building
 104 @section Building
 105
 106 Click uses the standard GNU build system, so the basic installation
 107 procedure looks like this:
 108
 109 @example
 110 ./configure
 111 make
 112 make install
 113 @end example
 114
 115 @node Tutorial
 116 @chapter Tutorial
 117
 118 Click Tutorial
 119
 120 @node Contributing
 121 @chapter Contributing
 122
 123 @c *********************************************************************
 124 @node GNU Free Documentation License
 125 @appendix GNU Free Documentation License
 126
 127 @include fdl-1.3.texi
 128
 129 @c *********************************************************************
 130 @node Concept Index
 131 @unnumbered Concept Index
 132 @printindex cp
 133
 134 @node Programming Index
 135 @unnumbered Programming Index
 136 @syncodeindex tp fn
 137 @syncodeindex vr fn
 138 @printindex fn
 139
 140 @bye
 141
 142 @c Local Variables:
 143 @c ispell-local-dictionary: "american";
 144 @c End: