summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc
diff options
context:
space:
mode:
authorNorbert Preining <preining@logic.at>2011-05-09 22:51:10 +0000
committerNorbert Preining <preining@logic.at>2011-05-09 22:51:10 +0000
commit6e1df2e361a83766f6360f4dfd8325ce3efa6426 (patch)
tree200cfd298dc8ca69839f93522c35d88daa3dfc5d /Master/tlpkg/doc
parentd8548c119c273878addf09f7b91b0350a8d0b008 (diff)
remove tlpkg/dev/keyword-search, move the docu to tlpkg/doc
git-svn-id: svn://tug.org/texlive/trunk@22392 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/doc')
-rw-r--r--Master/tlpkg/doc/tlmgr-keyword-search-interface.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/Master/tlpkg/doc/tlmgr-keyword-search-interface.txt b/Master/tlpkg/doc/tlmgr-keyword-search-interface.txt
new file mode 100644
index 00000000000..2b955040470
--- /dev/null
+++ b/Master/tlpkg/doc/tlmgr-keyword-search-interface.txt
@@ -0,0 +1,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).
+