[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4. Project Tree Inventory Commands

4.1 inventory  inventory a source tree
4.2 tree-lint  audit a source tree
4.3 id  report the inventory id for a file
4.4 id-tagging-method  print or change a project tree id tagging method
4.5 add-id  add an explicit inventory id
4.6 add  (alias for add-id)
4.7 delete-id  remove an explicit inventory id
4.8 delete  (alias for delete-id)
4.9 rm  remove a file (or dir, or symlink) and its explicit inventory tag (if any)
4.10 move-id  move an explicit inventory id
4.11 move  (alias for move-id)
4.12 mv  move a file (or dir, or symlink) and it's explicit inventory tag (if any)
4.13 explicit-default  print or modify default ids
4.14 default-id  (alias for explicit-default)
4.15 id-tagging-defaults  print the default =tagging-method contents

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1 inventory

inventory a source tree

usage: tla inventory [options] [--] [dir]*

 
  -h, --help          display help
  -H                  Display a verbose help message and exit.
  -V, --version       display version info
                      
  -s, --source        list source files
  -p, --precious      list precious files
  -b, --backups       list backup files
  -j, --junk          list junk files
  -u, --unrecognized  list unrecognized files
  -t, --trees         list roots of nested trees
                      
  -d, --directories   list only directories
  -f, --files         list only non-directories
  -B, --both          list both dirs and files
  --kind              indicate file kinds
                      
  --all               include arch control files
  --nested            include nested trees
                      
  --ids               list with ids (source files only)
  --untagged          include files that are missing ids
                      
  --explicit          use explicit file ids
  --implicit          permit implicit file ids
  --tagline           permit tagline file ids
  --names             use name-based file ids

With no arguments, print a human-readable inventory report.

With category options (--source etc) limit the report to just those files. With no other options, the report includes all sections and files.

The options -d, -f, and -b cancel each other.

If a directory is precious, junk, or unrecognized, only the directory name itself is printed -- its contents are not searched.

Each command option implies the corresponding category option (e.g. "--source-command" implies "--source"). The exit status of the command is ignored.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.2 tree-lint

audit a source tree

usage: tla tree-lint [options] [dir]

 
  -h, --help                Display a help message and exit.
  -H                        Display a verbose help message and exit.
  -V, --version             Display a release identifier string
                            and exit.
  -s, --broken-symlinks     Just list broken symlinks
  -u, --unrecognized-files  Just list files violating naming conventions
  -t, --untagged-files      Just list files lacking inventory ids
  -m, --missing-files       Just list inventory ids lacking corresponding files
  -d, --duplicate-ids       Just list duplicated ids
  --strict                  exit with non-0 status on _any_ oddity

Audit a source tree for missing files, untagged files, duplicate ids, and files not matching recognized naming conventions.

The default is to list files failing any of those tests. Enabling any of the `specific' tests disables the rest, unless they're explicitly enabled on the command line. Therefore, "tla tree-lint" is equivalent to "tla tree-lint -sutmd"


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.3 id

report the inventory id for a file

usage: tla id [options] file ...

 
  -h, --help      Display a help message and exit.
  -H              Display a verbose help message and exit.
  -V, --version   Display a release identifier string
                  and exit.
  --implicit      Use the implicit id tagging method.
  --tagline       Use the tagline id tagging method (default).
  --explicit      Use the explicit id tagging method.
  --names         Use the names id tagging method.
  --silent        No output -- exit status only.

Print a file's inventory id.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4 id-tagging-method

print or change a project tree id tagging method

usage: tla id-tagging-method [options] [method]

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.
  -d, --dir DIR  cd to DIR first
  --strict       exit with error if method not set

Print or change the method by which source files are identified in DIR (or the current directory).

When setting, METHOD must be one of:

 
        names           -- use naming conventions only
        implicit        -- use naming conventions but permit
                           for inventory tags
        explicit        -- require explicit designation of source
        tagline         -- mix names, explicit and arch-tag: methods

When printing, if --strict is provided but no id tagging method is explicitly set, print an error.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.5 add-id

add an explicit inventory id

usage: tla add-id [options] file ...

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.
  -i, --id ID    Specify ID, instead of using auto-generated id.

Create an explicit inventory id for FILE (which may be a regular file, symbolic link, or directory).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.6 add

(alias for add-id)

usage: tla add [options] file ...

add an explicit inventory id

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.
  -i, --id ID    Specify ID, instead of using auto-generated id.

Create an explicit inventory id for FILE (which may be a regular file, symbolic link, or directory).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.7 delete-id

remove an explicit inventory id

usage: tla delete-id [options] file ...

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.

Remove an explicit inventory id for FILE (which may be a regular file, symbolic link, or directory).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.8 delete

(alias for delete-id)

usage: tla delete [options] file ...

remove an explicit inventory id

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.

Remove an explicit inventory id for FILE (which may be a regular file, symbolic link, or directory).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.9 rm

remove a file (or dir, or symlink) and its explicit inventory tag (if any)

usage: tla rm [options] file...

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.10 move-id

move an explicit inventory id

usage: tla move-id [options] from to

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.

Move an explicit inventory id for FILE (which may be a regular file or symbolic link but which must not be a directory).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.11 move

(alias for move-id)

usage: tla move [options] from to

move an explicit inventory id

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.

Move an explicit inventory id for FILE (which may be a regular file or symbolic link but which must not be a directory).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.12 mv

move a file (or dir, or symlink) and it's explicit inventory tag (if any)

usage: tla mv [options] from to OR from1 from2 ... dir

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.

This command is suitable as a replacement for mv(1) within any tla tree for any move operation, regardless of id tagging method.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.13 explicit-default

print or modify default ids

usage: tla explicit-default [options] [TAG-PREFIX]

 
  -h, --help       Display a help message and exit.
  -H               Display a verbose help message and exit.
  -V, --version    Display a release identifier string
                   and exit.
  -D, --dir DIR    cd to DIR first
  -d, --delete     remove the default
  -s, --strong     use the strong default (default)
  -w, --weak       use the weak default
  --dont-care      use the dont-care default

For files in this directory, use:

 
     ID-PREFIX__BASENAME

as the default explicit id for all files in this directory that do not have an explicit explicit id.

With no arguments, print the previously set ID-PREFIX.

By default, this command sets, prints or deletes a "strong default" -- a default explicit id which overrides implicit ids.

With --weak, set (or print) a weak default id which is overridden by explicit ids.

The --dont-care option sets (or with -d, clears) a flag for that directory that causes unidged files not to be reported as such in "tla tree-lint" reports.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.14 default-id

(alias for explicit-default)

usage: tla default-id [options] [TAG-PREFIX]

print or modify default ids

 
  -h, --help       Display a help message and exit.
  -H               Display a verbose help message and exit.
  -V, --version    Display a release identifier string
                   and exit.
  -D, --dir DIR    cd to DIR first
  -d, --delete     remove the default
  -s, --strong     use the strong default (default)
  -w, --weak       use the weak default
  --dont-care      use the dont-care default

For files in this directory, use:

 
     ID-PREFIX__BASENAME

as the default explicit id for all files in this directory that do not have an explicit explicit id.

With no arguments, print the previously set ID-PREFIX.

By default, this command sets, prints or deletes a "strong default" -- a default explicit id which overrides implicit ids.

With --weak, set (or print) a weak default id which is overridden by explicit ids.

The --dont-care option sets (or with -d, clears) a flag for that directory that causes unidged files not to be reported as such in "tla tree-lint" reports.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.15 id-tagging-defaults

print the default =tagging-method contents

usage: tla id-tagging-defaults [options]

 
  -h, --help     Display a help message and exit.
  -H             Display a verbose help message and exit.
  -V, --version  Display a release identifier string
                 and exit.

Print the boilerplate contents that are used to initialize new =tagging-method files.


[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

This document was generated by wilk on May, 11 2004 using texi2html