summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc/tlmgr-keyword-search-interface.txt
blob: 2b955040470d3a815c8998746a8df49afff79503 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
How to interface tlmgr search with keywords

new search interface:

tlmgr search <options> <literal>
	searches the normal way, i.e., pkg names, short/long desc
tlmgr search <options> --file <literal>
	searches the current --file way, i.e., the list of files of a package
tlmgr search <options> --taxonomy <literal>
	searches the taxonomy (keyword, functionality, characterization)
tlmgr search <options> --extended <terms>
	allows full searching (will maybe implemented later)

<options> ::= --global | --word | --list [keywords|functions|characterizations]

<terms> ::=  <term> | <term> <terms>
<term>  ::=  AND  | OR  |  LEFT | RIGHT
              keyword=<literal> | function=<levels> | 
	      characterization=<levels> |
	      package-name=<literal> | title=<literal> |
	      description=<literal> | file=<literal>

<levels> ::= <level> | <level> " > " <levels>
<level>  ::= <literal>


defaults = package-names=ARG OR titles=ARG OR descriptions=ARG
AND -> conjunction
OR  -> disjunction
LEFT|RIGHT -> parenthesis for grouping of and and or

<literal> may contain wildcards and it is matched in a glob style (no re!!)


example
	tlmgr search keyword=paragraph AND description=dropped
should give back the lettrine package

	tlmgr search characterization=bibliography
searches for all packages with characterization containing anywhere the string
"bibliography" (case insensitive).