|
| 1 | +.TH GNULIB\-TOOL 1 "2006-06-01" "0.0.20060601" "GNU Portability Library" |
| 2 | + |
| 3 | +.SH NAME |
| 4 | +gnulib\-tool \- program for authors or maintainers which want to import modules |
| 5 | +from gnulib into their packages. |
| 6 | + |
| 7 | +.SH SYNOPSIS |
| 8 | +.B gnulib\-tool |
| 9 | +\-\-list |
| 10 | +.PP |
| 11 | +.B gnulib\-tool |
| 12 | +\-\-import [module1 ... moduleN] |
| 13 | +.PP |
| 14 | +.B gnulib\-tool |
| 15 | +\-\-update |
| 16 | +.PP |
| 17 | +.B gnulib\-tool |
| 18 | +\-\-create-testdir \-\-dir=directory module1 ... moduleN |
| 19 | +.PP |
| 20 | +.B gnulib\-tool |
| 21 | +\-\-create-megatestdir \-\-dir=directory [module1 ... moduleN] |
| 22 | +.PP |
| 23 | +.B gnulib\-tool |
| 24 | +\-\-test \-\-dir=directory module1 ... moduleN |
| 25 | +.PP |
| 26 | +.B gnulib\-tool |
| 27 | +\-\-megatest \-\-dir=directory [module1 ... moduleN] |
| 28 | +.PP |
| 29 | +.B gnulib\-tool |
| 30 | +\-\-extract-description module |
| 31 | +.PP |
| 32 | +.B gnulib\-tool |
| 33 | +\-\-extract-filelist module |
| 34 | +.PP |
| 35 | +.B gnulib\-tool |
| 36 | +\-\-extract-dependencies module |
| 37 | +.PP |
| 38 | +.B gnulib\-tool |
| 39 | +\-\-extract-autoconf-snippet module |
| 40 | +.PP |
| 41 | +.B gnulib\-tool |
| 42 | +\-\-extract-automake-snippet module |
| 43 | +.PP |
| 44 | +.B gnulib\-tool |
| 45 | +\-\-extract-include-directive module |
| 46 | +.PP |
| 47 | +.B gnulib\-tool |
| 48 | +\-\-extract-license module |
| 49 | +.PP |
| 50 | +.B gnulib\-tool |
| 51 | +\-\-extract-maintainer module |
| 52 | +.PP |
| 53 | +.B gnulib\-tool |
| 54 | +\-\-extract-tests-module module |
| 55 | + |
| 56 | +.SH DESCRIPTION |
| 57 | +The GNU portability library is a macro system and C declarations and definitions |
| 58 | +for commonly-used API elements and abstracted system behaviors. It can be used |
| 59 | +to improve portability and other functionality in your programs. |
| 60 | +.PP |
| 61 | + |
| 62 | +.SH OPTIONS |
| 63 | +Operation modes: |
| 64 | +.TP |
| 65 | +.B \-\-list |
| 66 | +print the available module names. |
| 67 | +.TP |
| 68 | +.B \-\-import |
| 69 | +import the given modules into the current package; if no modules are specified, |
| 70 | +update the current package from the current gnulib. |
| 71 | +.TP |
| 72 | +.B \-\-update |
| 73 | +update the current package, restore files omitted from CVS. |
| 74 | +.TP |
| 75 | +.B \-\-create-testdir |
| 76 | +create a scratch package with the given modules. |
| 77 | +.TP |
| 78 | +.B \-\-create-megatestdir |
| 79 | +create a mega scratch package with the given modules one by one and all |
| 80 | +together. |
| 81 | +.TP |
| 82 | +.B \-\-test |
| 83 | +test the combination of the given modules (recommended to use CC="gcc \-Wall" |
| 84 | +here). |
| 85 | +.TP |
| 86 | +.B \-\-megatest |
| 87 | +test the given modules one by one and all together (recommended to use CC="gcc |
| 88 | +\-Wall" here). |
| 89 | +.TP |
| 90 | +.B \-\-extract-description |
| 91 | +extract the description. |
| 92 | +.TP |
| 93 | +.B \-\-extract-filelist |
| 94 | +extract the list of files. |
| 95 | +.TP |
| 96 | +.B \-\-extract-dependencies |
| 97 | +extract the dependencies. |
| 98 | +.TP |
| 99 | +.B \-\-extract-autoconf-snippet |
| 100 | +extract the snippet for configure.ac. |
| 101 | +.TP |
| 102 | +.B \-\-extract-automake-snippet |
| 103 | +extract the snippet for lib/Makefile.am. |
| 104 | +.TP |
| 105 | +.B \-\-extract-include-directive |
| 106 | +extract the #include directive. |
| 107 | +.TP |
| 108 | +.B \-\-extract-license |
| 109 | +report the license terms of the source files under lib/. |
| 110 | +.TP |
| 111 | +.B \-\-extract-maintainer |
| 112 | +report the maintainer(s) inside gnulib. |
| 113 | +.TP |
| 114 | +.B \-\-extract-tests-module |
| 115 | +report the unit test module, if it exists. |
| 116 | +.PP |
| 117 | + |
| 118 | +Options: |
| 119 | +.TP |
| 120 | +.B \-\-dir=DIRECTORY |
| 121 | +specify the target directory. For \-\-import, this specifies where your |
| 122 | +configure.ac can be found. Defaults to current directory. |
| 123 | +.TP |
| 124 | +.B \-\-lib=LIBRARY |
| 125 | +Specify the library name. Defaults to 'libgnu'. |
| 126 | +.TP |
| 127 | +.B \-\-source-base=DIRECTORY |
| 128 | +Directory relative \-\-dir where source code is placed (default "lib"), for |
| 129 | +\-\-import. |
| 130 | +.TP |
| 131 | +.B \-\-m4-base=DIRECTORY |
| 132 | +Directory relative \-\-dir where *.m4 macros are placed (default "m4"), for |
| 133 | +\-\-import. |
| 134 | +.TP |
| 135 | +.B \-\-tests-base=DIRECTORY |
| 136 | +Directory relative \-\-dir where unit tests are placed (default "tests"), for |
| 137 | +\-\-import. |
| 138 | +.TP |
| 139 | +.B \-\-aux-dir=DIRECTORY |
| 140 | +Directory relative \-\-dir where auxiliary build tools are placed (default |
| 141 | +"build-aux"). |
| 142 | +.TP |
| 143 | +.B \-\-with-tests |
| 144 | +Include unit tests for the included modules. |
| 145 | +.TP |
| 146 | +.B \-\-avoid=MODULE |
| 147 | +Avoid including the given MODULE. Useful if you have code that provides |
| 148 | +equivalent functionality. This option can be repeated. |
| 149 | +.TP |
| 150 | +.B \-\-lgpl |
| 151 | +Abort if modules aren't available under the LGPL. Also modify license template |
| 152 | +from GPL to LGPL. |
| 153 | +.TP |
| 154 | +.B \-\-libtool |
| 155 | +Use libtool rules, for \-\-import. |
| 156 | +.TP |
| 157 | +.B \-\-macro-prefix=PREFIX |
| 158 | +Specify the prefix of the macros 'gl_EARLY' and 'gl_INIT'. Default is 'gl'. |
| 159 | +.TP |
| 160 | +.B \-\-no-changelog |
| 161 | +don't update or create ChangeLog files. |
| 162 | +.TP |
| 163 | +.B \-\-dry-run |
| 164 | +For \-\-import, only print what would have been done. |
| 165 | +.TP |
| 166 | +.B -s, \-\-symbolic, \-\-symlink |
| 167 | +Make symbolic links instead of copying files. |
| 168 | +.PP |
| 169 | +.TP |
| 170 | +.B \-h, \-\-help |
| 171 | +Show summary of options. |
| 172 | + |
| 173 | +.SH BUGS |
| 174 | +Report bugs to <bug-gnulib@gnu.org>. |
| 175 | + |
| 176 | +.SH SEE ALSO |
| 177 | +.BR check-module (1). |
| 178 | + |
| 179 | +.SH AUTHOR |
| 180 | +gnulib was written by the Free Software Foundation and others (sources of various origins). |
| 181 | +.PP |
| 182 | +This manual page was written by Daniel Baumann <daniel@debian.org>, for the Debian project (but may be used by others). |
0 commit comments