# Indexing profile template for Pathena

# Copy this file to a new profile name and edit as needed.  This file
# also exists in unannotated form under the name 'profile_template'.
# You may have as many profiles as you wish.


# ---------- Special indexing categories ----------

# Categories are provided for application-specific files needing special
# treatment.  Typically these files are stored under a single directory
# tree.  Each special category requires a custom module to traverse the
# tree and index whatever portions make sense for full-text searching.

# Indexing directives for special files use this format:
#    special <genus> <species> <directory 1> ... <directory N>
# where <genus> is one of the established genera or file categories and
# <species> is a recognized file type within that category.
# Currently allowable special types are listed below.

#special email maildir ~/Mail   # for e-mail clients that use 'maildir' format


# ---------- Regular file indexing ----------

# Directories, files and patterns of same may appear in exclusion lists
# to constrain the selection of paths in later sections of the profile.
# Directories from the special types above are automatically excluded
# from the remainder of the profile.

# Two types of exclusion directives are allowed.  The first type is 
# evaluated only once at the beginning of an indexing run.  Its patterns
# should expand to full path names, usually in the user's home directory.

#exclude ~/Desktop

# The second type contains patterns that are evaluated within each
# visited directory.  Patterns of this type are used to exclude
# subdirectories that can appear at any level of the file hierarchy.

#ignore .* CVS Mail


# ---------- Path indexing ----------

# A file can be indexed using its path name only or using both path name
# and file content.  Any file can have its path name indexed but only
# those of supported, recognizable types can have their content indexed.

# All files and directories within the following subtrees (except those
# excluded above) will have their path names indexed and become eligible
# for possible content indexing later in the profile.  All patterns
# listed should be expandable to full path names.

#path ~


# ---------- Content indexing ----------

# Some files contained in the path sets implied above can have their
# content indexed for full-text searching.  Any file whose extension is
# associated with the types below will be indexed according to the rules
# for the corresponding file type.  Some types require a converter to
# map files into plain text.  Conversions and other type-specific
# operations are defined by modules in ~/.pathena/types.

# NOTE: There are two types of patterns used in Pathena profiles.
# Those appearing above this point are file/path name patterns (also
# called 'globbing' patterns), which can include the metacharacters
# ~ * ? as interpreted by command shells.  Below this point, patterns 
# take the form of full-featured, string-based regular expressions,
# where the pattern '.*' matches zero or more arbitrary characters.


# ---------- Common file categories ----------

# Content indexing directives use this format:
#    content <genus> <species-1> ... <species-N>
# where <genus> is one of the established file categories and <species-i>
# is a regular expression pattern that matches recognized file types
# within the category <genus>.

# For example, to index all types of documents, add the directive
# 'content doc .*'.  Common species are listed below for each genus.
# To see the full list of recognized file types, choose the item
# View > Show Indexable File Types from the Pathena client menubar.

#content node     .*   ###  direc link

#content exec     .*   ###  script

#content text     plain   ###  plain no_ext 

#content doc      .*   ###  pdf postscript msword oowriter ...

#content archive  .*   ###  tar zip rpm

#content markup   .*   ###  html xml tex

#content source   .*   ###  c cpp java lisp perl python ...


# ---------- Compressed file types ----------

# To index files that have been compressed, add the following directive
# to indicate which types of compressed data should be included.
# Currently supported compression formats are listed below.

#compress  ### gzip bzip2

# For example, if 'gzip' is selected, every file having extension '.gz'
# will be uncompressed to recover its file contents, then indexed as
# a regular file.  If its file name has the form <name>.<ext>.gz, then
# indexing would proceed as it would for a file having extension <ext>.
