Switch to unified view

a/src/README b/src/README
...
...
65
65
66
                             4.2.1. Installing through a package system
66
                             4.2.1. Installing through a package system
67
67
68
                             4.2.2. Installing a prebuilt Recoll
68
                             4.2.2. Installing a prebuilt Recoll
69
69
70
                4.3. Packages needed for external file types
71
70
                4.3. Configuration overview
72
                4.4. Configuration overview
71
73
72
                             4.3.1. Main configuration file
74
                             4.4.1. Main configuration file
73
75
74
                             4.3.2. The mimemap file
76
                             4.4.2. The mimemap file
75
77
76
                             4.3.3. The mimeconf file
78
                             4.4.3. The mimeconf file
77
79
78
     ----------------------------------------------------------------------
80
     ----------------------------------------------------------------------
79
81
80
                            Chapter 1. Introduction
82
                            Chapter 1. Introduction
81
83
...
...
450
452
451
   You may also need libiconv. Recoll currently uses version 1.9 (this should
453
   You may also need libiconv. Recoll currently uses version 1.9 (this should
452
   not be critical). On Linux systems, the iconv interface is part of libc
454
   not be critical). On Linux systems, the iconv interface is part of libc
453
   and you should not need to do anything special.
455
   and you should not need to do anything special.
454
456
455
   External file types. Recoll uses external applications to index some file
456
   types. You need to install them for the file types that you wish to have
457
   indexed (these are run-time dependencies. None is needed for building
458
   Recoll):
459
460
     * PDF: pdftotext is part of the Xpdf package.
461
462
     * Postscript: pstotext.
463
464
     * MS Word: antiword.
465
466
     * RTF: unrtf
467
468
     * dvi: dvips
469
470
     * djvu: DjVuLibre
471
472
     * MP3: Recoll will use the id3info command from the id3lib package to
473
       extract tag information. Without it, only the filenames will be
474
       indexed.
475
476
   Text, Html, mail folders and Openoffice files are processed internally.
477
478
     ----------------------------------------------------------------------
457
     ----------------------------------------------------------------------
479
458
480
  4.1.2. Building
459
  4.1.2. Building
481
460
482
   Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3),
461
   Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3),
...
...
550
   After extracting the tar file, you can proceed with installation as if you
529
   After extracting the tar file, you can proceed with installation as if you
551
   had built the package from source.
530
   had built the package from source.
552
531
553
     ----------------------------------------------------------------------
532
     ----------------------------------------------------------------------
554
533
534
4.3. Packages needed for external file types
535
536
   Recoll uses external applications to index some file types. You need to
537
   install them for the file types that you wish to have indexed (these are
538
   run-time dependencies. None is needed for building Recoll):
539
540
     * PDF: pdftotext is part of the Xpdf package.
541
542
     * Postscript: pstotext.
543
544
     * MS Word: antiword.
545
546
     * RTF: unrtf
547
548
     * dvi: dvips
549
550
     * djvu: DjVuLibre
551
552
     * MP3: Recoll will use the id3info command from the id3lib package to
553
       extract tag information. Without it, only the filenames will be
554
       indexed.
555
556
   Text, Html, mail folders and Openoffice files are processed internally.
557
558
     ----------------------------------------------------------------------
559
555
4.3. Configuration overview
560
4.4. Configuration overview
556
561
557
   There are two sets of configuration files. The system-wide files are kept
562
   There are two sets of configuration files. The system-wide files are kept
558
   in a directory named like /usr/[local/]share/recoll/examples, they define
563
   in a directory named like /usr/[local/]share/recoll/examples, they define
559
   default values for the system. A parallel set of files exists in the
564
   default values for the system. A parallel set of files exists in the
560
   .recoll directory in your home (this can be changed with the
565
   .recoll directory in your home (this can be changed with the
...
...
605
   White space is used for separation inside lists. Elements with embedded
610
   White space is used for separation inside lists. Elements with embedded
606
   spaces can be quoted using double-quotes.
611
   spaces can be quoted using double-quotes.
607
612
608
     ----------------------------------------------------------------------
613
     ----------------------------------------------------------------------
609
614
610
  4.3.1. Main configuration file
615
  4.4.1. Main configuration file
611
616
612
   recoll.conf is the main configuration file. It defines things like what to
617
   recoll.conf is the main configuration file. It defines things like what to
613
   index (top directories and things to ignore), and the default character
618
   index (top directories and things to ignore), and the default character
614
   set to use for document types which do not specify it internally.
619
   set to use for document types which do not specify it internally.
615
620
...
...
620
625
621
   Paramers:
626
   Paramers:
622
627
623
   topdirs
628
   topdirs
624
629
625
           Specifies the list of directories to index (recursively).
630
           Specifies the list of directories or files to index (recursively
631
           for directories). The indexer will not follow symbolic links
632
           inside the indexed trees. If an entry in the topdirs list is a
633
           symbolic link, indexation will not start and will generate an
634
           error.
626
635
627
   skippedNames
636
   skippedNames
628
637
629
           A space-separated list of patterns for names of files or
638
           A space-separated list of patterns for names of files or
630
           directories that should be completely ignored. The list defined in
639
           directories that should be completely ignored. The list defined in
...
...
712
           indexation, or for all files inside the selected subtrees,
721
           indexation, or for all files inside the selected subtrees,
713
           independant of mime type.
722
           independant of mime type.
714
723
715
     ----------------------------------------------------------------------
724
     ----------------------------------------------------------------------
716
725
717
  4.3.2. The mimemap file
726
  4.4.2. The mimemap file
718
727
719
   mimemap specifies the file name extension to mime type mappings.
728
   mimemap specifies the file name extension to mime type mappings.
720
729
721
   For file names without an extension, or with an unknown one, the system's
730
   For file names without an extension, or with an unknown one, the system's
722
   file -i command will be executed to determine the mime type (this can be
731
   file -i command will be executed to determine the mime type (this can be
...
...
737
   configuration file, with two differences: it will not affect directories,
746
   configuration file, with two differences: it will not affect directories,
738
   and it can be changed for any subdirectory.
747
   and it can be changed for any subdirectory.
739
748
740
     ----------------------------------------------------------------------
749
     ----------------------------------------------------------------------
741
750
742
  4.3.3. The mimeconf file
751
  4.4.3. The mimeconf file
743
752
744
   mimeconf specifies how the different mime types are handled for
753
   mimeconf specifies how the different mime types are handled for
745
   indexation, and for display.
754
   indexation, and for display.
746
755
747
   Changing the indexation parameters is probably not a good idea except if
756
   Changing the indexation parameters is probably not a good idea except if