NAME

lsa - list files and directories with annotation


SYNOPSIS

lsa [OPTION]... [FILE]...


DESCRIPTION

List information about files and directories with annotations. Along with the usual ls-type output, provides both system- and user-level text annotations.

Typically, you would use this program to provide short descriptions of the contents, function or format of the file.

        $ lsa 
        README.txt      "Instructions for compiling the program."
        docs/           "Main users guide is in this directory."
        src/            "Updated 01/01/2008 from svn repo."

You can also assign your own tags to all files and directories, including ones that you don't own.

        $ lsa --assign-tag=sysinfo /proc
        /proc   "sysinfo"
        $ lsa --assign-tag=helpful /proc
        /proc   "sysinfo,helpful"

Searching and grouping by tag and by description (as well as the usual features of filename, date, size, etc.) are all available.

        $ lsa --tag "helpful"
        /proc


OPTIONS

We can divide the options into those that set annotations, those that query them, and those few used to administer them.

All of the options can accept one or more names, whether names of files or directories or other file system objects. If none are given, the operations will default to acting on the current directory. This may not be what you want especially when you are setting annotations, so it is better to be specific as the filename when you are assigning a description or tag.


SETTING ANNOTATIONS

--assign-tag=tag

Assigns the given tag value to the specified file or directory. If neither is given, the current directory is used. tag may be any text of arbitrary length, although single words are recommended.

--assign-ann[=annotation]

Assigns annotation in the same manner as the tag described above. Annotations can be of any length and contain any characters, including HTML or other markup schemes. Currently (April 29, 2008), lsa does not interpret any markups.

If the annotation is not given as an argument, stdin will be used to accept the annotation. Multiple lines of annotation are accepted.


QUERYING ANNOTATIONS

--tag[=tag,tag,...]

List any items in the given directory that contain any of the given tags. The list of tags is OR'd by default.


ADMINISTERING ANNOTATIONS


EXAMPLES


FUTURE DIRECTIONS


FILES


BUGS


SEE ALSO


AUTHOR


COPYRIGHT AND LICENSE