Commits

Paul Ruane committed cd4804b

Fixed formatting and typos of README. Updated 'files' command help.

  • Participants
  • Parent commits c509b67
  • Tags v0.4.0

Comments (0)

Files changed (2)

 Overview
 ========
 
-TMSU is a program that allows you to organise your files by associating them
-with tags. It provides a tool for managing these tags and a virtual filesystem
-to allow tag-based access to your files.
+TMSU is a tool for tagging your files. It provides a simple command-line utility
+for applying tags and a virtual filesystem to give you a tag-based view of your
+files from any other program.
 
-TMSU's virtual filesystem does not store your files: it merely provides an
-alternative, tag-based view of your files stored elsewhere in the filesystem.
-That way you have the freedom to choose the most suitable filesystem for
-storage whilst still benefiting from tag-based access.
+TMSU does not alter your files in any way: they remain unchanged on disk, or on
+the network, wherever your put them. TMSU maintains its own database and you
+simply gain an additional view, which you can mount where you like, based upon
+the tags you set up.
 
 Usage
 =====
 
     $ tmsu help
 
-Full documentation is maintained online on the wiki:
+Documentation is maintained online on the wiki:
 
   * <http://bitbucket.org/oniony/tmsu/wiki>
 
         $ hg clone -r release https://bitbucket.org/oniony/tmsu
 
     Active development takes place on the default branch. This branch is subject
-    to build failures and breaking changes:
+    to build failures and breaking changes but will have the latest
+    functionality and improvements:
 
         $ hg clone https://bitbucket.org/oniony/tmsu
 
 
     This will install TMSU to '/usr/bin/tmsu'.
 
-    It will also install the Zsh completion to '/usr/share/zsh/site-functions'.
+    It will also install the Zsh completion to '/usr/share/zsh/site-functions'
+    and mount wrapper to '/usr/sbin'.
 
-    To change the paths used override the environment variables in the Makefile.
+    To change the paths used override the variables at the top of the Makefile.
 
 About
 =====
 v0.4.0 (in development)
 ------
 
-  Note: This release changes the database schema. To upgrade your v0.3.0
-  database please run the following:
+  *Note: This release changes the database schema to facilitate tag values. To
+  upgrade your existing v0.3.0 database please run the following:*
 
-    $ cp ~/.tmsu/default.db ~/.tmsu/default.db.bak
+    $ cp ~/.tmsu/default.db ~/.tmsu/default.db.backup
     $ sqlite3 -init misc/db-upgrade/0.3_to_0.4.0.sql ~/.tmsu/default.db .q
 
   * Added support for tag values, e.g. 'tmsu tag song.mp3 country=uk' and the
   * 'tags' and 'values' commands now tabulate output, by default, when run
     from terminal.
   * Added ability to configure which fingerprint algorithm to use.
-  * Implied tags now calculated on the fly when the database is queried. This
-    results in a (potentially) smaller database and ability to have update to the
+  * Implied tags now calculated on-the-fly when the database is queried. This
+    results in a (potentially) smaller database and ability to have updates to the
     implied tags affect previously tagged files.
-  * Added --explicit option to 'files' and 'tags' commands to show only explicit
-    tags: omitting the on-the-fly implied tags.
+  * Added --explicit option to 'files' and 'tags' commands to show only
+    explicit tags (omitting any implied tags).
   * Added --path option to 'files' command to retrieve just those files matching
     or under the path specified.
   * Added --untagged option to 'files' command which, when combined with --path,
     of fingerprints of unmodified files.
   * Renamed --force option of 'repair' command to --remove.
   * Added support for textual comparison operators: 'eq', 'ne', 'lt', 'gt',
-    'le' and 'ge'. These remove the need for escaping.
+    'le' and 'ge', which do not need escaping unlike '<', '>', &c.
   * Improved Zsh completion with respect to tag values.
   * Significant performance improvements.
   * Removed support for '-' operator: use 'not' instead.
 v0.3.0
 ------
 
-  Note: This release changes what tag names are allowed. To ensure the tag
+  *Note: This release changes what tag names are allowed. To ensure the tag
   names in your existing databases are still valid, please run the following
-  script:
+  script:*
 
-    $ cp ~/.tmsu/default.db ~/.tmsu/default.db.bak
+    $ cp ~/.tmsu/default.db ~/.tmsu/default.db.backup
     $ sqlite3 -init misc/db-upgrade/clean_tag_names.sql ~/.tmsu/default.db
 
   * Added support for file queries, e.g. 'fish and chips and (mushy-peas or

File src/tmsu/cli/files.go

 
 Lists the files that match the QUERY specified.
 
-QUERY may contain:
+QUERY may contain tag names to match, logical operators, comparison operators
+and parentheses.
 
-  * Tag names to match
-  * The logical operators: and or not
-  * The comparison operators: =   !=   >   <   >=   <=
-                              eq  ne   gt  lt  ge   le
-  * Parentheses: ( )
+  * Logical operators: and, or, not
+  * Comparison operators: ==, !=, <,  >,  <=, >=
+                          eq, ne, lt, gt, le, ge
 
 The 'and' operator may be omitted for brevity, e.g. 'chalk cheese' is
 interpretted as 'chalk and cheese'.
 
-Note: Your shell may interpret some of the punctuation, e.g. most shells will
-interpret the '<' and '>' operators as stream redirects. Either enclose the
-query in quotation marks, escape the problematic characters or use the text
-versions, e.g. 'eq' for '='.
+Note: Your shell may interpret some punctuation, e.g. '<' and '>' as stream
+redirects. Either enclose the query in quotation marks, escape the problematic
+characters or use the equivalent text operators, e.g. 'lt' for '<'.
 
 Examples: