annotate README @ 3:fd9ff64a1fe9

README: added instruction to make a logical AND with filters
author Goffi <goffi@goffi.org>
date Thu, 22 Jul 2010 21:28:29 +0800
parents 6f4b5e24cf08
children a8b144574340
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
6f4b5e24cf08 README update
Goffi <goffi@goffi.org>
parents: 0
diff changeset
1 lm v0.1.1
0
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
2 (c) Jérôme Poisson aka Goffi 2010
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
3
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
4 lm is of software to list movies, loosely inspired from ls.
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
5
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
6
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
7
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
8 ** LICENSE **
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
9
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
10 lm is free software: you can redistribute it and/or modify
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
11 it under the terms of the GNU General Public License as published by
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
12 the Free Software Foundation, either version 3 of the License, or
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
13 (at your option) any later version.
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
14
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
15 lm is distributed in the hope that it will be useful,
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
18 GNU General Public License for more details.
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
19
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
20 You should have received a copy of the GNU General Public License
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
21 along with lm. If not, see <http://www.gnu.org/licenses/>.
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
22
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
23
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
24
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
25 ** WTF ? **
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
26
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
27 lm list media files (only movies so far), getting information on IMDb, allowing you to display sexy titles (instead of often unreadable filename), sort by rating, display plot, etc.
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
28
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
29
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
30
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
31 ** How to use it ? **
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
32
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
33 lm --help
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
34
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
35 each time you launch lm, it gets metadata for files it doesn't know, which is really slow. So, be sure to try on a directory with a few movies to test it.
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
36
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
37 ** Filters **
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
38
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
39 you can filter your query using the --filter argument (or the short -f)
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
40 Currently, you can filter on genre, director or actor.
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
41 The syntax is --filter @keyword:filter,filter,filter@keyword2:filter,filter
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
42 e.g.:
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
43 lm --filter "@director:tim burton@genre:drama,fantasy"
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
44
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
45 filters are case insensitive
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
46
3
fd9ff64a1fe9 README: added instruction to make a logical AND with filters
Goffi <goffi@goffi.org>
parents: 2
diff changeset
47 filter user logical OR (it means that lm --filter "@genre:sci-fi,comedy" will return all science-fiction movies and all comedies ("Starship Troopers" and "Le dîner de cons" are accepted by this filter).
fd9ff64a1fe9 README: added instruction to make a logical AND with filters
Goffi <goffi@goffi.org>
parents: 2
diff changeset
48 If you want to use a logical AND, you can use two time the filter: lm --f@genre:sci-fi@genre:comedy will return all science-fiction movies which are also comedies (like "Galaxy Quest").
fd9ff64a1fe9 README: added instruction to make a logical AND with filters
Goffi <goffi@goffi.org>
parents: 2
diff changeset
49
0
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
50
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
51 ** Credit **
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
52
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
53 Internet Movie Database (IMDb) is one of the oldest site on Internet, and, as its name says, give a lot of informations on movies
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
54
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
55 IMDbPY:
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
56 lm use IMDbPY to get information on IMDb (http://imdbpy.sourceforge.net/), many thanks to its authors
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
57
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
58
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
59
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
60 ** See also **
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
61
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
62 You can also have a look on my other projets:
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
63 - SàT: a XMMP client in heavy development, my main project at the moment
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
64 - mkvconvert: a small script to convert mkv files unreadable with vlc to mkv with xvid
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
65
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
66
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
67
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
68 ** Contact **
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
69
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
70 You can contact me on goffi@goffi.org
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
71 You'll find the latest version on my website: http://www.goffi.org (it's mainly in french, I will probably make a little part in english in the future).
c6e7b3287d65 Initial commit: first public realease (0.1)
Goffi <goffi@goffi.org>
parents:
diff changeset
72