1git-annex-view(1)           General Commands Manual          git-annex-view(1)
2
3
4

NAME

6       git-annex-view - enter a view branch
7

SYNOPSIS

9       git  annex view [tag ...] [field=value ...] [field=glob ...] [?tag ...]
10       [field?=glob] [!tag ...] [field!=value ...]
11

DESCRIPTION

13       Uses metadata to build a view  branch  of  the  files  in  the  current
14       branch,  and  checks  out  the  view  branch. Only files in the current
15       branch whose metadata matches all the specified field values  and  tags
16       will be shown in the view.
17
18       Multiple  values for a metadata field can be specified, either by using
19       a glob (field="*") or by listing each wanted value. The resulting  view
20       will  put  files  in  subdirectories  according  to  the value of their
21       fields.
22
23       Once within such a view, you can make additional directories, and  copy
24       or  move files into them. When you commit, the metadata will be updated
25       to correspond to your changes. Deleting files and committing  also  up‐
26       dates the metadata.
27
28       As well as the usual metadata, there are fields available corresponding
29       to the path to the  file.  So  a  file  "foo/bar/baz/file"  has  fields
30       "/=foo",  "foo/=bar",  and "foo/bar/=baz". These location fields can be
31       used the same as other metadata to construct the view.
32
33       For example, /=foo will only include files from the  foo  directory  in
34       the  view, while foo/=* will preserve the subdirectories of the foo di‐
35       rectory in the view.
36
37       To enter a view containing only files that lack a given metadata  value
38       or tag, specify field!=value or !tag. (Globs cannot be used here.)
39
40       field?=*  is  like field=* but adds an additional directory named _ (by
41       default) that contains files that do not have  the  field  set  to  any
42       value.   Similarly, ?tag adds an additional directory named _ that con‐
43       tains files that do not have any tags set. Moving files from the _  di‐
44       rectory  to another directory and committing will set the metadata. And
45       moving files into the _ directory and committing will unset  the  meta‐
46       data.
47
48       The name of the _ directory can be changed using the annex.viewunsetdi‐
49       rectory git config.
50
51       Filenames in the view branch include their  path  within  the  original
52       branch,  to  ensure that they are unique. The path comes after the main
53       filename, and before any extensions. For  example,  "foo/bar.baz"  will
54       have  a name like "bar_%foo%.baz". annex.maxextensionlength can be used
55       to configure what is treated as an extension.
56

OPTIONS

58       The git-annex-common-options(1) can be used.
59

SEE ALSO

61       git-annex(1)
62
63       git-annex-metadata(1)
64
65       git-annex-vpop(1)
66
67       git-annex-vfilter(1)
68
69       git-annex-vadd(1)
70
71       git-annex-vcycle(1)
72
73       git-annex-adjust(1)
74

AUTHOR

76       Joey Hess <id@joeyh.name>
77
78                                                             git-annex-view(1)
Impressum