runtime/doc/Makefile

   1 #
   2 # Makefile for the Vim documentation on Unix
   3 #
   4 # If you get "don't know how to make scratch", first run make in the source
   5 # directory.  Or remove the include below.
   6
   7 AWK = awk
   8
   9 # Set to $(VIMTARGET) when executed from src/Makefile.
  10 VIMEXE = vim
  11
  12 # include the config.mk from the source directory.  It's only needed to set
  13 # AWK, used for "make html".  Comment this out if the include gives problems.
  14 include ../../src/auto/config.mk
  15
  16 DOCS = \
  17         ada.txt \
  18         arabic.txt \
  19         autocmd.txt \
  20         change.txt \
  21         cmdline.txt \
  22         debugger.txt \
  23         debug.txt \
  24         develop.txt \
  25         diff.txt \
  26         digraph.txt \
  27         editing.txt \
  28         eval.txt \
  29         farsi.txt \
  30         filetype.txt \
  31         fold.txt \
  32         gui.txt \
  33         gui_w16.txt \
  34         gui_w32.txt \
  35         gui_x11.txt \
  36         hacks.txt \
  37         hangulin.txt \
  38         hebrew.txt \
  39         help.txt \
  40         howto.txt \
  41         if_cscop.txt \
  42         if_mzsch.txt \
  43         if_ole.txt \
  44         if_perl.txt \
  45         if_pyth.txt \
  46         if_ruby.txt \
  47         if_sniff.txt \
  48         if_tcl.txt \
  49         indent.txt \
  50         index.txt \
  51         insert.txt \
  52         intro.txt \
  53         map.txt \
  54         message.txt \
  55         motion.txt \
  56         mbyte.txt \
  57         mlang.txt \
  58         netbeans.txt \
  59         options.txt \
  60         os_390.txt \
  61         os_amiga.txt \
  62         os_beos.txt \
  63         os_dos.txt \
  64         os_mac.txt \
  65         os_mint.txt \
  66         os_msdos.txt \
  67         os_os2.txt \
  68         os_qnx.txt \
  69         os_risc.txt \
  70         os_unix.txt \
  71         os_vms.txt \
  72         os_win32.txt \
  73         pattern.txt \
  74         pi_getscript.txt \
  75         pi_gzip.txt \
  76         pi_netrw.txt \
  77         pi_paren.txt \
  78         pi_spec.txt \
  79         pi_tar.txt \
  80         pi_vimball.txt \
  81         pi_zip.txt \
  82         print.txt \
  83         quickfix.txt \
  84         quickref.txt \
  85         quotes.txt \
  86         recover.txt \
  87         remote.txt \
  88         repeat.txt \
  89         rileft.txt \
  90         russian.txt \
  91         scroll.txt \
  92         sign.txt \
  93         sponsor.txt \
  94         starting.txt \
  95         spell.txt \
  96         sql.txt \
  97         syntax.txt \
  98         tabpage.txt \
  99         tagsrch.txt \
 100         term.txt \
 101         tips.txt \
 102         todo.txt \
 103         uganda.txt \
 104         undo.txt \
 105         usr_01.txt \
 106         usr_02.txt \
 107         usr_03.txt \
 108         usr_04.txt \
 109         usr_05.txt \
 110         usr_06.txt \
 111         usr_07.txt \
 112         usr_08.txt \
 113         usr_09.txt \
 114         usr_10.txt \
 115         usr_11.txt \
 116         usr_12.txt \
 117         usr_20.txt \
 118         usr_21.txt \
 119         usr_22.txt \
 120         usr_23.txt \
 121         usr_24.txt \
 122         usr_25.txt \
 123         usr_26.txt \
 124         usr_27.txt \
 125         usr_28.txt \
 126         usr_29.txt \
 127         usr_30.txt \
 128         usr_31.txt \
 129         usr_32.txt \
 130         usr_40.txt \
 131         usr_41.txt \
 132         usr_42.txt \
 133         usr_43.txt \
 134         usr_44.txt \
 135         usr_45.txt \
 136         usr_90.txt \
 137         usr_toc.txt \
 138         various.txt \
 139         version4.txt \
 140         version5.txt \
 141         version6.txt \
 142         version7.txt \
 143         vi_diff.txt \
 144         visual.txt \
 145         windows.txt \
 146         workshop.txt
 147
 148 HTMLS = \
 149         ada.html \
 150         arabic.html \
 151         autocmd.html \
 152         change.html \
 153         cmdline.html \
 154         debug.html \
 155         debugger.html \
 156         develop.html \
 157         diff.html \
 158         digraph.html \
 159         editing.html \
 160         eval.html \
 161         farsi.html \
 162         filetype.html \
 163         fold.html \
 164         gui.html \
 165         gui_w16.html \
 166         gui_w32.html \
 167         gui_x11.html \
 168         hangulin.html \
 169         hebrew.html \
 170         howto.html \
 171         if_cscop.html \
 172         if_mzsch.html \
 173         if_ole.html \
 174         if_perl.html \
 175         if_pyth.html \
 176         if_ruby.html \
 177         if_sniff.html \
 178         if_tcl.html \
 179         indent.html \
 180         index.html \
 181         vimindex.html \
 182         insert.html \
 183         intro.html \
 184         map.html \
 185         message.html \
 186         motion.html \
 187         mbyte.html \
 188         mlang.html \
 189         netbeans.html \
 190         options.html \
 191         os_390.html \
 192         os_amiga.html \
 193         os_beos.html \
 194         os_dos.html \
 195         os_mac.html \
 196         os_mint.html \
 197         os_msdos.html \
 198         os_os2.html \
 199         os_qnx.html \
 200         os_risc.html \
 201         os_unix.html \
 202         os_vms.html \
 203         os_win32.html \
 204         pattern.html \
 205         pi_getscript.html \
 206         pi_gzip.html \
 207         pi_netrw.html \
 208         pi_paren.html \
 209         pi_spec.html \
 210         pi_tar.html \
 211         pi_vimball.html \
 212         pi_zip.html \
 213         print.html \
 214         quickfix.html \
 215         quickref.html \
 216         quotes.html \
 217         recover.html \
 218         remote.html \
 219         repeat.html \
 220         rileft.html \
 221         russian.html \
 222         scroll.html \
 223         sign.html \
 224         sponsor.html \
 225         starting.html \
 226         spell.html \
 227         sql.html \
 228         syntax.html \
 229         tabpage.html \
 230         tags.html \
 231         tagsrch.html \
 232         term.html \
 233         tips.html \
 234         todo.html \
 235         uganda.html \
 236         undo.html \
 237         usr_01.html \
 238         usr_02.html \
 239         usr_03.html \
 240         usr_04.html \
 241         usr_05.html \
 242         usr_06.html \
 243         usr_07.html \
 244         usr_08.html \
 245         usr_09.html \
 246         usr_10.html \
 247         usr_11.html \
 248         usr_12.html \
 249         usr_20.html \
 250         usr_21.html \
 251         usr_22.html \
 252         usr_23.html \
 253         usr_24.html \
 254         usr_25.html \
 255         usr_26.html \
 256         usr_27.html \
 257         usr_28.html \
 258         usr_29.html \
 259         usr_30.html \
 260         usr_31.html \
 261         usr_32.html \
 262         usr_40.html \
 263         usr_41.html \
 264         usr_42.html \
 265         usr_43.html \
 266         usr_44.html \
 267         usr_45.html \
 268         usr_90.html \
 269         usr_toc.html \
 270         various.html \
 271         version4.html \
 272         version5.html \
 273         version6.html \
 274         version7.html \
 275         vi_diff.html \
 276         visual.html \
 277         windows.html \
 278         workshop.html
 279
 280 CONVERTED = \
 281         vim-fr.UTF-8.1 \
 282         evim-fr.UTF-8.1 \
 283         vimdiff-fr.UTF-8.1 \
 284         vimtutor-fr.UTF-8.1 \
 285         xxd-fr.UTF-8.1 \
 286         vim-it.UTF-8.1 \
 287         evim-it.UTF-8.1 \
 288         vimdiff-it.UTF-8.1 \
 289         vimtutor-it.UTF-8.1 \
 290         xxd-it.UTF-8.1 \
 291         vim-ru.UTF-8.1 \
 292         evim-ru.UTF-8.1 \
 293         vimdiff-ru.UTF-8.1 \
 294         vimtutor-ru.UTF-8.1 \
 295         xxd-ru.UTF-8.1 \
 296
 297 .SUFFIXES:
 298 .SUFFIXES: .c .o .txt .html
 299
 300 all: tags vim.man vimdiff.man vimtutor.man xxd.man $(CONVERTED)
 301
 302 # Use Vim to generate the tags file.  Can only be used when Vim has been
 303 # compiled and installed.  Supports multiple languages.
 304 vimtags: $(DOCS)
 305         $(VIMEXE) -u NONE -esX -c "helptags ++t ." -c quit
 306
 307 # Use "doctags" to generate the tags file.  Only works for English!
 308 tags: doctags $(DOCS)
 309         ./doctags $(DOCS) | LANG=C LC_ALL=C sort >tags
 310         uniq -d -2 tags
 311
 312 doctags: doctags.c
 313         $(CC) doctags.c -o doctags
 314
 315 vim.man: vim.1
 316         nroff -man vim.1 | sed -e s/.\b//g > vim.man
 317
 318 vimdiff.man: vimdiff.1
 319         nroff -man vimdiff.1 | sed -e s/.\b//g > vimdiff.man
 320
 321 vimtutor.man: vimtutor.1
 322         nroff -man vimtutor.1 | sed -e s/.\b//g > vimtutor.man
 323
 324 xxd.man: xxd.1
 325         nroff -man xxd.1 | sed -e s/.\b//g > xxd.man
 326
 327 uganda.nsis.txt: uganda.txt
 328         sed -e 's/[     ]*\*[-a-zA-Z0-9.]*\*//g' -e 's/vim:tw=78://' \
 329                 uganda.txt | uniq >uganda.nsis.txt
 330
 331 # Awk version of .txt to .html conversion.
 332 html: noerrors tags tags.ref $(HTMLS)
 333         @if test -f errors.log; then more errors.log; fi
 334
 335 noerrors:
 336         -rm -f errors.log
 337
 338 .txt.html:
 339         $(AWK) -f makehtml.awk $< >$@
 340
 341 # index.html is the starting point for HTML, but for the help files it is
 342 # help.txt.  Therefore use vimindex.html for index.txt.
 343 index.html: help.txt
 344         $(AWK) -f makehtml.awk help.txt >index.html
 345
 346 vimindex.html: index.txt
 347         $(AWK) -f makehtml.awk index.txt >vimindex.html
 348
 349 tags.ref tags.html: tags
 350         $(AWK) -f maketags.awk tags >tags.html
 351
 352 # Perl version of .txt to .html conversion.
 353 # There can't be two rules to produce a .html from a .txt file.
 354 # Just run over all .txt files each time one changes.  It's fast anyway.
 355 perlhtml: tags $(DOCS)
 356         ./vim2html.pl tags $(DOCS)
 357
 358 clean:
 359         -rm doctags *.html tags.ref
 360
 361 # These files are in the extra archive, skip if not present
 362
 363 arabic.txt:
 364         touch arabic.txt
 365
 366 farsi.txt:
 367         touch farsi.txt
 368
 369 hebrew.txt:
 370         touch hebrew.txt
 371
 372 russian.txt:
 373         touch russian.txt
 374
 375 gui_w16.txt:
 376         touch gui_w16.txt
 377
 378 gui_w32.txt:
 379         touch gui_w32.txt
 380
 381 if_ole.txt:
 382         touch if_ole.txt
 383
 384 os_390.txt:
 385         touch os_390.txt
 386
 387 os_amiga.txt:
 388         touch os_amiga.txt
 389
 390 os_beos.txt:
 391         touch os_beos.txt
 392
 393 os_dos.txt:
 394         touch os_dos.txt
 395
 396 os_mac.txt:
 397         touch os_mac.txt
 398
 399 os_mint.txt:
 400         touch os_mint.txt
 401
 402 os_msdos.txt:
 403         touch os_msdos.txt
 404
 405 os_os2.txt:
 406         touch os_os2.txt
 407
 408 os_qnx.txt:
 409         touch os_qnx.txt
 410
 411 os_risc.txt:
 412         touch os_risc.txt
 413
 414 os_win32.txt:
 415         touch os_win32.txt
 416
 417 # Note that $< works with GNU make while $> works for BSD make.
 418 # Is there a solution that works for both??
 419 vim-fr.UTF-8.1: vim-fr.1
 420         iconv -f latin1 -t utf-8 $< >$@
 421
 422 evim-fr.UTF-8.1: evim-fr.1
 423         iconv -f latin1 -t utf-8 $< >$@
 424
 425 vimdiff-fr.UTF-8.1: vimdiff-fr.1
 426         iconv -f latin1 -t utf-8 $< >$@
 427
 428 vimtutor-fr.UTF-8.1: vimtutor-fr.1
 429         iconv -f latin1 -t utf-8 $< >$@
 430
 431 xxd-fr.UTF-8.1: xxd-fr.1
 432         iconv -f latin1 -t utf-8 $< >$@
 433
 434 vim-it.UTF-8.1: vim-it.1
 435         iconv -f latin1 -t utf-8 $< >$@
 436
 437 evim-it.UTF-8.1: evim-it.1
 438         iconv -f latin1 -t utf-8 $< >$@
 439
 440 vimdiff-it.UTF-8.1: vimdiff-it.1
 441         iconv -f latin1 -t utf-8 $< >$@
 442
 443 vimtutor-it.UTF-8.1: vimtutor-it.1
 444         iconv -f latin1 -t utf-8 $< >$@
 445
 446 xxd-it.UTF-8.1: xxd-it.1
 447         iconv -f latin1 -t utf-8 $< >$@
 448
 449 vim-ru.UTF-8.1: vim-ru.1
 450         iconv -f KOI8-R -t utf-8 $< >$@
 451
 452 evim-ru.UTF-8.1: evim-ru.1
 453         iconv -f KOI8-R -t utf-8 $< >$@
 454
 455 vimdiff-ru.UTF-8.1: vimdiff-ru.1
 456         iconv -f KOI8-R -t utf-8 $< >$@
 457
 458 vimtutor-ru.UTF-8.1: vimtutor-ru.1
 459         iconv -f KOI8-R -t utf-8 $< >$@
 460
 461 xxd-ru.UTF-8.1: xxd-ru.1
 462         iconv -f KOI8-R -t utf-8 $< >$@