~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
-------------------------------------------------------------------------------
 
2
-- Copyright (c) 1998-2005,2006 Free Software Foundation, Inc.               --
 
3
--                                                                           --
 
4
-- Permission is hereby granted, free of charge, to any person obtaining a   --
 
5
-- copy of this software and associated documentation files (the             --
 
6
-- "Software"), to deal in the Software without restriction, including       --
 
7
-- without limitation the rights to use, copy, modify, merge, publish,       --
 
8
-- distribute, distribute with modifications, sublicense, and/or sell copies --
 
9
-- of the Software, and to permit persons to whom the Software is furnished  --
 
10
-- to do so, subject to the following conditions:                            --
 
11
--                                                                           --
 
12
-- The above copyright notice and this permission notice shall be included   --
 
13
-- in all copies or substantial portions of the Software.                    --
 
14
--                                                                           --
 
15
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
 
16
-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
 
17
-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
 
18
-- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
 
19
-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
 
20
-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
 
21
-- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
 
22
--                                                                           --
 
23
-- Except as contained in this notice, the name(s) of the above copyright    --
 
24
-- holders shall not be used in advertising or otherwise to promote the      --
 
25
-- sale, use or other dealings in this Software without prior written        --
 
26
-- authorization.                                                            --
 
27
-------------------------------------------------------------------------------
 
28
-- $Id: INSTALL,v 1.114 2006/12/17 19:58:19 tom Exp $
1
29
---------------------------------------------------------------------
2
30
             How to install Ncurses/Terminfo on your system
3
31
---------------------------------------------------------------------
318
345
 
319
346
    --disable-macros
320
347
        For testing, use functions rather than macros.  The program will run
321
 
        more slowly, but it is simpler to debug.  This makes a header file
322
 
        "nomacros.h".  See also the --enable-expanded option.
 
348
        more slowly, but it is simpler to debug.  This defines NCURSES_NOMACROS
 
349
        at build time.  See also the --enable-expanded option.
323
350
 
324
351
    --disable-overwrite
325
352
        If you are installing ncurses on a system which contains another
341
368
        Compile without scroll-hints code.  This option is ignored when
342
369
        hashmap scrolling is configured, which is the default.
343
370
 
 
371
    --disable-tparm-varargs
 
372
        Portable programs should call tparm() using the fixed-length parameter
 
373
        list documented in X/Open.  ncurses provides varargs support for this
 
374
        function.  Use --disable-tparm-varargs to disable this support.
 
375
 
344
376
    --enable-assertions
345
377
        For testing, compile-in assertion code.  This is used only for a few
346
378
        places where ncurses cannot easily recover by returning an error code.
421
453
        cross-references to) the terminfo tree, but it is faster than reading
422
454
        /etc/termcap.
423
455
 
 
456
        If configured for one of the *BSD systems, this automatically uses
 
457
        the hashed database system produced using cap_mkdb or similar tools.
 
458
        In that case, there is no advantage in using the --enable-getcap-cache
 
459
        option.
 
460
 
 
461
        See also the --with-hashed-db option.
 
462
 
424
463
    --enable-getcap-cache
425
464
        Cache translated termcaps under the directory $HOME/.terminfo
426
465
 
444
483
        extended functions.
445
484
 
446
485
    --enable-rpath
447
 
        Use rpath option when generating shared libraries, and with some
448
 
        restrictions when linking the corresponding programs.  This applies
449
 
        mainly to systems using the GNU linker (read the manpage).
 
486
        Use rpath option when generating shared libraries, and (with some
 
487
        restrictions) when linking the corresponding programs.  This originally
 
488
        (in 1997) applied mainly to systems using the GNU linker (read the
 
489
        manpage).
 
490
 
 
491
        More recently it is useful for systems that require special treatment
 
492
        shared libraries in "unusual" locations.  The "system" libraries reside
 
493
        in directories which are on the loader's default search-path.  While
 
494
        you may be able to use workarounds such as the $LD_LIBRARY_PATH
 
495
        environment variable, they do not work with setuid applications since
 
496
        the LD_LIBRARY_PATH variable would be unset in that situation.
450
497
 
451
498
    --enable-safe-sprintf
452
499
        Compile with experimental safe-sprintf code.  You may consider using
460
507
        changes.  This option is the default, unless you have disabled the
461
508
        extended functions.
462
509
 
 
510
    --enable-signed-char
 
511
        The term.h header declares a Booleans[] array typed "char".  But it
 
512
        stores signed values there and "char" is not necessarily signed.
 
513
        Some packagers choose to alter the type of Booleans[] though this
 
514
        is not strictly compatible.  This option allows one to implement this
 
515
        alteration without patching the source code.
 
516
 
463
517
    --enable-symlinks
464
518
        If your system supports symbolic links, make tic use symbolic links
465
519
        rather than hard links to save diskspace when writing aliases in the
479
533
    --enable-warnings
480
534
        Turn on GCC compiler warnings.  There should be only a few.
481
535
 
 
536
    --enable-wgetch-events
 
537
        Compile with experimental wgetch-events code.  See ncurses/README.IZ
 
538
 
482
539
    --enable-widec
483
540
        Compile with wide-character code.  This makes a different version of
484
541
        the libraries (e.g., libncursesw.so), which stores characters as
567
624
 
568
625
    --with-dbmalloc
569
626
        For testing, compile and link with Conor Cahill's dbmalloc library.
 
627
        This also sets the --disable-leaks option.
570
628
 
571
629
    --with-debug
572
630
        Generate debug-libraries (default).  These are named by adding "_g"
576
634
        Specify the default terminfo database directory.  This is normally
577
635
        DATADIR/terminfo, e.g., /usr/share/terminfo.
578
636
 
579
 
    --with-develop
580
 
        Enable experimental/development options.  This does not count those
581
 
        that change the interface, such as --enable-widec.
582
 
 
583
637
    --with-dmalloc
584
638
        For testing, compile and link with Gray Watson's dmalloc library.
 
639
        This also sets the --disable-leaks option.
585
640
 
586
641
    --with-fallbacks=XXX
587
642
        Specify a list of fallback terminal descriptions which will be
589
644
 
590
645
    --with-gpm
591
646
        use Alessandro Rubini's GPM library to provide mouse support on the
592
 
        Linux console.  Prior to ncurses 5.5, this introduced a dependency
593
 
        on the GPM library.  Currently ncurses uses the dlsym() function to
594
 
        bind to the at runtime, so it is only necessary that the library be
595
 
        present when ncurses is built.
 
647
        Linux console.  Prior to ncurses 5.5, this introduced a dependency on
 
648
        the GPM library.
 
649
        
 
650
        Currently ncurses uses the dlsym() function to bind to the library at
 
651
        runtime, so it is only necessary that the library be present when
 
652
        ncurses is built, to obtain the filename (or soname) used in the
 
653
        corresponding dlopen() call.  If you give a value for this option,
 
654
        e.g.,
 
655
 
 
656
                --with-gpm=$HOME/tmp/test-gpm.so
 
657
 
 
658
        that overrides the configure check for the soname.
 
659
 
 
660
        See also --without-dlsym
 
661
 
 
662
    --with-hashed-db
 
663
        Use a hashed database for storing terminfo data rather than storing
 
664
        each compiled entry in a separate binary file within a directory
 
665
        tree.
 
666
 
 
667
        If you use this option for configuring ncurses, tic will only be able
 
668
        to write entries in the hashed database.  infocmp can still read
 
669
        entries from a directory tree as well as reading entries from the
 
670
        hashed database.  To do this, infocmp determines whether the $TERMINFO
 
671
        variable points to a directory or a file, and reads the directory-tree
 
672
        or hashed database respectively.
 
673
 
 
674
        You cannot have a directory containing both hashed-database and
 
675
        filesystem-based terminfo entries.
 
676
 
 
677
        See also the --enable-getcap option.
596
678
 
597
679
    --with-install-prefix=XXX
598
680
        Allows you to specify an alternate location for installing ncurses
678
760
    --with-normal
679
761
        Generate normal (i.e., static) libraries (default).
680
762
 
 
763
        Note:  on Linux, the configure script will attempt to use the GPM
 
764
        library via the dlsym() function call.  Use --without-dlsym to disable
 
765
        this feature, or --without-gpm, depending on whether you wish to use
 
766
        GPM.
 
767
 
681
768
    --with-profile
682
769
        Generate profile-libraries These are named by adding "_p" to the root,
683
770
        e.g., libncurses_p.a
750
837
        Configure the trace() function as part of the all models of the ncurses
751
838
        library.  Normally it is part of the debug (libncurses_g) library only.
752
839
 
 
840
    --with-valgrind
 
841
        For testing, compile with debug option.
 
842
        This also sets the --disable-leaks option.
 
843
 
753
844
    --without-ada
754
845
        Suppress the configure script's check for Ada95, do not build the
755
846
        Ada95 binding and related demo.
772
863
        Suppress the configure script's check for C++, do not build the
773
864
        C++ binding and related demo.
774
865
 
 
866
    --without-develop
 
867
        Disable development options.  This does not include those that change
 
868
        the interface, such as --enable-widec.
 
869
 
 
870
    --without-dlsym
 
871
        Do not use dlsym() to load GPM dynamically.
 
872
 
775
873
    --without-progs
776
874
        Tell the configure script to suppress the build of ncurses' application
777
875
        programs (e.g., tic).  The test applications will still be built if you
798
896
    you may encounter when building a system with different versions of
799
897
    ncurses:
800
898
 
 
899
    5.6 (December 17, 2006)
 
900
        Interface changes:
 
901
 
 
902
        + generate linkable stubs for some macros:
 
903
 
 
904
          getbegx, getbegy, getcurx, getcury, getmaxx, getmaxy, getparx,
 
905
          getpary, getpary,
 
906
 
 
907
          and (for libncursesw)
 
908
 
 
909
          wgetbkgrnd
 
910
 
 
911
        Added extensions:
 
912
                nofilter()
 
913
                use_legacy_coding()
 
914
 
 
915
        Added internal functions:
 
916
                _nc_first_db
 
917
                _nc_get_source
 
918
                _nc_handle_sigwinch
 
919
                _nc_is_abs_path
 
920
                _nc_is_dir_path
 
921
                _nc_is_file_path
 
922
                _nc_keep_tic_dir
 
923
                _nc_keep_tic_dir
 
924
                _nc_last_db
 
925
                _nc_next_db
 
926
                _nc_read_termtype
 
927
                _nc_tic_dir
 
928
 
 
929
                Also (if using the hashed database configuration):
 
930
 
 
931
                _nc_db_close
 
932
                _nc_db_first
 
933
                _nc_db_get
 
934
                _nc_db_have_data
 
935
                _nc_db_have_index
 
936
                _nc_db_next
 
937
                _nc_db_open
 
938
                _nc_db_put
 
939
 
 
940
                otherwise
 
941
 
 
942
                _nc_hashed_db
 
943
 
 
944
        Removed internal functions:
 
945
                none
 
946
 
 
947
        Modified internal functions:
 
948
                _nc_add_to_try
 
949
                _nc_do_color
 
950
                _nc_expand_try
 
951
                _nc_remove_key
 
952
                _nc_setupscreen
 
953
 
801
954
    5.5 (October 10, 2005)
802
955
        Interface changes:
803
956
 
1397
1550
 
1398
1551
        The Hacker's Guide in the doc directory includes some guidelines
1399
1552
        on how to report bugs in ways that will get them fixed most quickly.
 
1553
 
 
1554
-- vile:txtmode