├── .travis.yml ├── t ├── 07list.t ├── 04clear.t ├── 03rename.t ├── 02untagged.t ├── 01split.t ├── 05modify.t ├── 08cli.t └── 06search.t ├── Makefile.PL ├── README.pod ├── bin └── squaretag └── LICENSE /.travis.yml: -------------------------------------------------------------------------------- 1 | language: perl 2 | install: 3 | cpanm -n Devel::Cover Devel::Cover::Report::Coveralls 4 | script: 5 | perl Makefile.PL && make 6 | after_success: 7 | cover -test -report coveralls 8 | -------------------------------------------------------------------------------- /t/07list.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use FindBin '$Bin'; 7 | use Test::More; 8 | 9 | require_ok("$Bin/../bin/squaretag"); 10 | 11 | is_deeply( list_tags(qw/file[foo].txt file2[foo].txt file3.txt file4[bar].txt/), 12 | { foo => 2, bar => 1 } ); 13 | 14 | done_testing; 15 | -------------------------------------------------------------------------------- /t/04clear.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use FindBin '$Bin'; 7 | use Test::More; 8 | 9 | require_ok("$Bin/../bin/squaretag"); 10 | 11 | is_deeply( clear('file[foo].txt'), [ [ 'file[foo].txt' => 'file.txt' ] ] ); 12 | is_deeply( clear('file[bar,foo].txt'), 13 | [ [ 'file[bar,foo].txt' => 'file.txt' ] ] ); 14 | is_deeply( clear('file.txt'), [ [ 'file.txt' => 'file.txt' ] ] ); 15 | 16 | done_testing; 17 | -------------------------------------------------------------------------------- /t/03rename.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use FindBin '$Bin'; 7 | use Test::More; 8 | 9 | require_ok("$Bin/../bin/squaretag"); 10 | 11 | is_deeply( 12 | rename_tag( 'foo', 'bar', 'file[foo].txt' ), 13 | [ [ 'file[foo].txt' => 'file[bar].txt' ] ] 14 | ); 15 | is_deeply( rename_tag( 'foo', 'foo', 'file[foo].txt' ), [] ); 16 | is_deeply( rename_tag( 'bar', 'quux', 'file[foo].txt' ), [] ); 17 | 18 | done_testing; 19 | -------------------------------------------------------------------------------- /t/02untagged.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use FindBin '$Bin'; 7 | use Test::More; 8 | use File::Temp 'tempdir'; 9 | 10 | require_ok("$Bin/../bin/squaretag"); 11 | 12 | my $dir = tempdir( CLEANUP => 1 ); 13 | chdir($dir) or die "Can't chdir to $dir: $!"; 14 | 15 | is_deeply( find_untagged(()), [] ); 16 | is_deeply( find_untagged(qw(file01.txt)), [qw(file01.txt)] ); 17 | is_deeply( find_untagged(qw(file01.txt file02[foo].txt)), [qw(file01.txt)] ); 18 | is_deeply( find_untagged(qw(file01.txt file02[foo].txt file03.txt)), 19 | [qw(file01.txt file03.txt)] ); 20 | is_deeply( find_untagged(qw(file02[foo].txt)), [] ); 21 | 22 | done_testing; 23 | -------------------------------------------------------------------------------- /Makefile.PL: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | use strict; 3 | use warnings; 4 | use ExtUtils::MakeMaker; 5 | 6 | WriteMakefile( 7 | NAME => "App::squaretag", 8 | VERSION => 0.04, 9 | EXE_FILES => ['bin/squaretag'], 10 | META_MERGE => { 11 | "meta-spec" => { version => 2 }, 12 | resources => { 13 | repository => { 14 | type => 'git', 15 | url => 16 | 'git://github.com/mdom/squaretag.git', 17 | web => 18 | 'https://github.com/mdom/squaretag', 19 | }, 20 | }, 21 | }, 22 | ); 23 | 24 | sub MY::c_o { 25 | "cover:\n\tHARNESS_PERL_SWITCHES=-MDevel::Cover make test && cover"; 26 | } 27 | -------------------------------------------------------------------------------- /t/01split.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | use FindBin '$Bin'; 6 | use Test::More; 7 | 8 | require_ok("$Bin/../bin/squaretag"); 9 | 10 | my @tests = ( 11 | [ 12 | 'foo.tar.gz' => [ 'foo', '', '.tar.gz' ] => 13 | 'Handle special case for tar.gz' 14 | ], 15 | [ 'foo' => [ 'foo', '', '' ] => 'File without tag and extension' ], 16 | [ '[]' => [ '[]', '', '' ] => 'File with just []' ], 17 | [ '[foo]' => [ '[foo]', '', '' ] => 'File with just [foo]' ], 18 | [ '[foo].ext' => [ '[foo]', '', '.ext' ] => 'File with just [foo].ext' ], 19 | [ 20 | 'foo.txt' => [ 'foo', '', '.txt' ] => 21 | 'File without tag but with extension' 22 | ], 23 | [ 24 | 'foo[read].ext' => [ 'foo', 'read', '.ext' ] => 25 | 'File with tag and extension' 26 | ], 27 | [ 28 | 'foo[read,good].ext' => [ 'foo', 'read,good', '.ext' ] => 29 | 'File with tags and extension' 30 | ], 31 | [ 32 | 'foo[read,good]' => [ 'foo', 'read,good', '' ] => 33 | 'File with tags but no extension' 34 | ], 35 | [ 36 | 'foo[first book][read,good]' => 37 | [ 'foo[first book]', 'read,good', '' ] => 38 | 'File with tags and squares' 39 | ], 40 | [ 41 | 'foo[first book][read,good].ext' => 42 | [ 'foo[first book]', 'read,good', '.ext' ] => 43 | 'File with tags and squares and extension' 44 | ], 45 | [ 46 | '/foo/bar[quux].txt' => [ '/foo/bar', 'quux', '.txt' ] => 47 | 'File with path' 48 | ], 49 | [ 50 | 'c:\foo\bar[quux].txt' => [ 'c:\foo\bar', 'quux', '.txt' ] => 51 | 'File with windows path' 52 | ], 53 | ); 54 | 55 | for my $t (@tests) { 56 | is_deeply( [ split_file( $t->[0] ) ], $t->[1], $t->[2] ); 57 | } 58 | 59 | done_testing; 60 | -------------------------------------------------------------------------------- /t/05modify.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use FindBin '$Bin'; 7 | use Test::More; 8 | 9 | require_ok("$Bin/../bin/squaretag"); 10 | 11 | is_deeply( modify( 'foo', '+', 'file.txt' ), 12 | [ [ 'file.txt' => 'file[foo].txt' ] ] ); 13 | 14 | is_deeply( 15 | modify( 'foo+', '+', 'file.txt' ), 16 | [ [ 'file.txt' => 'file[foo].txt' ] ] 17 | ); 18 | 19 | is_deeply( 20 | modify( 'foo', '-', 'file[foo].txt' ), 21 | [ [ 'file[foo].txt' => 'file.txt' ] ] 22 | ); 23 | 24 | is_deeply( 25 | modify( 'foo-', '-', 'file[foo].txt' ), 26 | [ [ 'file[foo].txt' => 'file.txt' ] ] 27 | ); 28 | 29 | is_deeply( modify( 'foo-', '-', 'file.txt' ), [] ); 30 | 31 | is_deeply( modify( '', '-', 'file.txt' ), [] ); 32 | 33 | is_deeply( 34 | modify( 'foo,,bar-', '+', 'file.txt' ), 35 | [ [ 'file.txt' => 'file[foo].txt' ] ] 36 | ); 37 | 38 | is_deeply( 39 | modify( 'year=2016', '+', 'file.txt' ), 40 | [ [ 'file.txt' => 'file[year=2016].txt' ] ] 41 | ); 42 | 43 | is_deeply( 44 | modify( 'year', '+', 'file[year=2015].txt' ), 45 | [ [ 'file[year=2015].txt' => 'file[year].txt' ] ] 46 | ); 47 | 48 | is_deeply( 49 | modify( 'year=2016', '+', 'file[year=2015].txt' ), 50 | [ [ 'file[year=2015].txt' => 'file[year=2016].txt' ] ] 51 | ); 52 | 53 | is_deeply( 54 | modify( 'year', '-', 'file[year=2015].txt' ), 55 | [ [ 'file[year=2015].txt' => 'file.txt' ] ], 56 | 'Remove tagvalue with unvalued tag' 57 | ); 58 | 59 | is_deeply( 60 | modify( 'year=2015', '-', 'file[year=2015].txt' ), 61 | [ [ 'file[year=2015].txt' => 'file.txt' ] ], 62 | 'Remove tagvalue with identical valued tag' 63 | ); 64 | 65 | is_deeply( modify( 'year=2014', '-', 'file[year=2015].txt' ), [] ); 66 | is_deeply( 67 | modify( 'year=2016', '+', 'file[year].txt' ), 68 | [ [ 'file[year].txt' => 'file[year=2016].txt' ] ] 69 | ); 70 | 71 | is_deeply( 72 | modify( 'year=current', '+', 'file[year=2015].txt' ), 73 | [ [ 'file[year=2015].txt' => 'file[year=current].txt' ] ] 74 | ); 75 | 76 | is_deeply( 77 | modify( { separator => ' ' }, 'bar', '+', 'file[foo].txt' ), 78 | [ [ 'file[foo].txt' => 'file[bar foo].txt' ] ] 79 | ); 80 | 81 | is_deeply( 82 | modify( { separator => ' ' }, 'bar', '-', 'file[bar foo].txt' ), 83 | [ [ 'file[bar foo].txt' => 'file[foo].txt' ] ] 84 | ); 85 | 86 | done_testing; 87 | -------------------------------------------------------------------------------- /t/08cli.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use FindBin '$Bin'; 7 | use Test::More; 8 | use File::Temp 'tempdir'; 9 | 10 | require_ok("$Bin/../bin/squaretag"); 11 | 12 | my $tempdir = tempdir( CLEANUP => 1 ); 13 | chdir $tempdir; 14 | $ENV{HOME} = '.'; 15 | 16 | my $fh; 17 | open( $fh, '>', 'file.txt' ); 18 | 19 | sub capture { 20 | my (@args) = @_; 21 | my $got; 22 | local *STDOUT; 23 | open STDOUT, '>', \$got; 24 | local *STDERR; 25 | open STDERR, '>', \$got; 26 | eval { run(@args) }; 27 | if ($@) { 28 | $got .= $@; 29 | } 30 | return $got; 31 | } 32 | 33 | is capture(qw(add -v foo file.txt)), < file[foo].txt 35 | EOF 36 | 37 | is capture(qw(rename -v foo bar file[foo].txt)), < file[bar].txt 39 | EOF 40 | 41 | is capture(qw(list file[bar].txt)), < file[bar,foo].txt 51 | EOF 52 | 53 | is capture( 'remove', '-v', 'foo', 'file[bar,foo].txt' ), < file[bar].txt 55 | EOF 56 | 57 | is capture(qw(rename -v bar foo file[bar].txt)), < file[foo].txt 59 | EOF 60 | 61 | is capture(qw(clear -v file[foo].txt)), < file.txt 63 | EOF 64 | 65 | is capture(qw(untagged file.txt)), <', 'bar[foo].txt' ); 81 | open( $fh, '>', 'bar.txt' ); 82 | 83 | is capture(qw(add -v foo bar.txt)), <', '.squaretagrc' ); 97 | 98 | print $cfg qq{separator = " " # by space\n}; 99 | close $cfg; 100 | 101 | is capture(qw(add -v quux bar[foo].txt)), < bar[foo quux].txt 103 | EOF 104 | 105 | symlink( 'missing.txt', 'symlink.txt' ) or die "Can't create symlink: $!"; 106 | 107 | is capture(qw(add -v foo symlink.txt)), < symlink[foo].txt 109 | EOF 110 | 111 | chdir(".."); 112 | 113 | done_testing; 114 | -------------------------------------------------------------------------------- /t/06search.t: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use FindBin '$Bin'; 7 | use Test::More; 8 | 9 | require_ok("$Bin/../bin/squaretag"); 10 | 11 | is_deeply( search_tags( 'foo', 'file[foo].txt' ), ['file[foo].txt'] ); 12 | is_deeply( search_tags( 'bar', 'file[foo].txt' ), [] ); 13 | is_deeply( search_tags( 'bar', 'file[foo].txt', 'test[bar].txt' ), 14 | ['test[bar].txt'] ); 15 | 16 | is_deeply( search_tags( '!bar', 'file[foo].txt', 'test[bar].txt' ), 17 | ['file[foo].txt'] ); 18 | 19 | is_deeply( search_tags( 'foo', 'file[foo].txt', 'test[bar].txt' ), 20 | ['file[foo].txt'] ); 21 | 22 | is_deeply( search_tags( 'bar || foo', 'file[foo].txt', 'test[bar].txt' ), 23 | [ 'file[foo].txt', 'test[bar].txt' ] ); 24 | 25 | is_deeply( search_tags( 'year', 'file[year=2009].txt' ), 26 | ['file[year=2009].txt'] ); 27 | is_deeply( search_tags( 'year=2009', 'file[year=2009].txt' ), 28 | ['file[year=2009].txt'] ); 29 | is_deeply( search_tags( 'year=2008', 'file[year=2009].txt' ), [] ); 30 | is_deeply( search_tags( 'year>2008', 'file[year=2009].txt' ), 31 | ['file[year=2009].txt'] ); 32 | is_deeply( search_tags( 'year<2010', 'file[year=2009].txt' ), 33 | ['file[year=2009].txt'] ); 34 | is_deeply( search_tags( 'year>2010', 'file[year=2009].txt' ), [] ); 35 | is_deeply( search_tags( 'year>2010', 'file[foo].txt' ), [] ); 36 | is_deeply( search_tags( 'author=mdom', 'file[author=mdom].txt' ), 37 | ['file[author=mdom].txt'] ); 38 | is_deeply( search_tags( '!author=mdom', 'file[author=mdom].txt' ), [] ); 39 | is_deeply( search_tags( 'author=dom', 'file[author=mdom].txt' ), [] ); 40 | is_deeply( search_tags( 'author~dom', 'file[author=mdom].txt' ), 41 | ['file[author=mdom].txt'] ); 42 | 43 | is_deeply( 44 | search_tags( 45 | { implicit => '^(?.+?),' }, 46 | 'author=Pratchett', 47 | 'Pratchett, Terry - Colors of Magic.epub' 48 | ), 49 | ['Pratchett, Terry - Colors of Magic.epub'] 50 | ); 51 | 52 | is_deeply( 53 | search_tags( 54 | { implicit => '^(?.+?),' }, 55 | 'author=Pratchett', 56 | 'Pratchett, Terry - Colors of Magic[read].epub' 57 | ), 58 | ['Pratchett, Terry - Colors of Magic[read].epub'] 59 | ); 60 | 61 | is_deeply( 62 | search_tags( 63 | { implicit => '^(?.+?),' }, 64 | 'author=Pratchett', 65 | 'Pratchett, Terry - Colors of Magic[author=Assimov].epub' 66 | ), 67 | [] 68 | ); 69 | 70 | is_deeply( 71 | search_tags( 72 | { implicit => '^(?.+?),' }, 73 | 'author=Assimov', 74 | 'Pratchett, Terry - Colors of Magic[author=Assimov].epub' 75 | ), 76 | ['Pratchett, Terry - Colors of Magic[author=Assimov].epub'] 77 | ); 78 | 79 | is_deeply( 80 | search_tags( 81 | { implicit => '^(?.+?),' }, 82 | 'implicit()', 83 | 'Pratchett, Terry - Colors of Magic[author=Assimov].epub' 84 | ), 85 | ['Pratchett, Terry - Colors of Magic[author=Assimov].epub'] 86 | ); 87 | 88 | is_deeply( 89 | search_tags( 90 | { implicit => '^(?.+?),' }, 91 | 'implicit()', 92 | 'Pratchett - Colors of Magic[author=Assimov].epub' 93 | ), 94 | [] 95 | ); 96 | 97 | is_deeply( search_tags( 'tagged()', 'file[author=mdom].txt' ), 98 | ['file[author=mdom].txt'] ); 99 | 100 | is_deeply( search_tags( '!tagged()', 'file[author=mdom].txt' ), [] ); 101 | 102 | BEGIN { 103 | *CORE::GLOBAL::exit = sub (;$) { } 104 | } 105 | 106 | sub capture { 107 | my $code = shift; 108 | my $got; 109 | local *STDOUT; 110 | open STDOUT, '>', \$got; 111 | local *STDERR; 112 | open STDERR, '>', \$got; 113 | eval { $code->(); }; 114 | if ($@) { 115 | $got .= $@; 116 | } 117 | return $got; 118 | } 119 | 120 | is capture( sub { search_tags( 'author < mdom', 'file[author=mdom].txt' ) } ), 121 | < mdom', 'file[author=mdom].txt' ) } ), 125 | < ', 'file[author=mdom].txt' ) } ), 130 | < &&', 'file[author=mdom].txt' ) } ), 135 | < Coverage Status 4 | 5 | =head1 NAME 6 | 7 | squaretag - tag files by using filenames 8 | 9 | =head1 SYNOPSIS 10 | 11 | squaretag [-s SEP] [-r] add [-v] [-n] [-f] TAG [[FILES...]] 12 | squaretag [-s SEP] [-r] remove [-v] [-n] [-f] TAG [[FILES...]] 13 | squaretag [-r] clear [-v] [-n] [-f] [[FILES...]] 14 | squaretag [-s SEP] [-r] rename [-v] [-n] [-f] OLD_TAG NEW_TAG [[FILES...]] 15 | squaretag [-s SEP] [-r] list [[FILES...]] 16 | squaretag [-s SEP] [-r] search [-I REGEX] SEARCH [[FILES...]] 17 | 18 | =head1 DESCRIPTION 19 | 20 | Squaretag helps you to organize your files by tagging them. The tags 21 | are saved in the filename by adding all tags in square brackets either 22 | at the end of the filename or just before the last dot. 23 | 24 | =head1 MAINTENANCE MODE 25 | 26 | This project is in maintenance mode. That means there will be no more 27 | active feature development. 28 | 29 | =head1 EXAMPLES 30 | 31 | Suppose the current directory contains the following files: 32 | 33 | $ squaretag search '!tagged()' 34 | picture01.jpg 35 | picture02 36 | 37 | Now you want to add the tag I to all pictures. 38 | 39 | $ squaretag add -v family 40 | picture01.jpg -> picture01[family].jpg 41 | picture02 -> picture02[family] 42 | 43 | Files can have multiple tags 44 | 45 | $ squaretag add -v myself picture01[family].jpg 46 | picture01[family].jpg -> picture01[family,myself].jpg 47 | 48 | You can rename single tags 49 | 50 | $ squaretag rename -v myself me picture01[family,myself].jpg 51 | picture01[family,myself].jpg -> picture01[family,me].jpg 52 | 53 | Or delete a tag 54 | 55 | $ squaretag remove me -v picture01[family,me].jpg 56 | picture01[family,me].jpg -> picture01[family].jpg 57 | 58 | And what would tags be good for if you couldn't search for them 59 | 60 | $ squaretag search 'family && !me' 61 | picture02[family] 62 | 63 | And if you have enough, you can simple clear all tags 64 | 65 | $ squaretag clear -v 66 | picture01[family].jpg -> picture01.jpg 67 | picture02[family] -> picture02 68 | 69 | Tags can also have values: 70 | 71 | $ squaretag add read=2016 book.epub 72 | $ squaretag search 'read>2010' 73 | books[read=2016].epub 74 | $ squaretag search 'read<2010' 75 | $ squaretag search 'read=2016' 76 | books[read=2016].epub 77 | 78 | =head1 COMMANDS 79 | 80 | =over 4 81 | 82 | =item add TAG [FILES...] 83 | 84 | Add TAG to FILES. TAG is a comma seperated list of tags to add. If 85 | a tag has a suffix of I<-> this tag will be removed from the file. 86 | 87 | =item remove TAG [FILES...] 88 | 89 | Remove TAG from FILES. TAG is a comma seperated list of tags to remove. If 90 | a tag has a suffix of I<+> this tag will be added to the file. 91 | 92 | =item search SPEC [FILES...] 93 | 94 | List all FILES that match the search SPEC. SPEC can contain tags and 95 | the usual boolean operators. 96 | 97 | For example: 98 | 99 | read && good 100 | !read || (not_read && prio ) 101 | 102 | There are four additional operators I>, I>, I<=> and I<~> 103 | to handle tags with values. 104 | 105 | The function I returns true if the file has any explicit tags, 106 | I if it has any implicit tags. 107 | 108 | =over 4 109 | 110 | =item I<=> 111 | 112 | Compares if operands are string-equal. 113 | 114 | =item I>, I> 115 | 116 | Numerical less-than or more-than comparison. 117 | 118 | =item I<~> 119 | 120 | Checks if left operand contains right operand as substring. 121 | 122 | =back 123 | 124 | =item clear [FILES...] 125 | 126 | Remove all tags from FILES. 127 | 128 | =item sort [FILES...] 129 | 130 | Sort tags in all FILES with tags. 131 | 132 | =item rename OLD_TAG NEW_TAG [FILES...] 133 | 134 | Rename OLD_TAG in NEW_TAG in all FILES. 135 | 136 | =item list [FILES...] 137 | 138 | List and count all tags for FILES. The tags are sorted in descending 139 | order of frequency. 140 | 141 | =back 142 | 143 | =head1 OPTIONS 144 | 145 | =over 4 146 | 147 | =item --verbose|-v 148 | 149 | Print what squaretag does. 150 | 151 | =item --dry-run|-n 152 | 153 | Just print which files squaretag would rename without doing it. 154 | 155 | =item --force 156 | 157 | Ignore warnings about tags that look like files and overwriting existing 158 | files. 159 | 160 | =item --separator=SEP|-s=SEP 161 | 162 | The string to separate tags. Defaults to I<,>. 163 | 164 | =item --recursive|-r 165 | 166 | Recurse into subdirectories. 167 | 168 | =item --extensions=LIST 169 | 170 | A comma separated list of extensions that are recognized by 171 | squartag. The leading dot is implied. This is only needed for extensions 172 | with a dot in them, normal extensions are handled by squartag without 173 | the need to specify them. 174 | 175 | =item --implicit=REGEX|-I=REGEX 176 | 177 | Apply regex to the basename of the file without its tags. All matched 178 | capture groups are added as tags with less precedence than the explicit 179 | tags. 180 | 181 | For example, if regex is '^(?(.+?),' and the file is called 182 | 'Pratchett, Terry - Color of Magic.epub', a tag I with the value 183 | of I is added. 184 | 185 | =back 186 | 187 | =head1 CONFIGURATION FILE 188 | 189 | squaretag will try to read I<$HOME/.squaretagrc> on startup. Empty lines 190 | are ignored, as is everything after I<#>. Everything else is a key-value 191 | combination separated by a equal sign. All options can be set. Quoting 192 | is optional, except to save trailings whitespace. 193 | 194 | separator = " " # by space! 195 | force = 1 196 | 197 | =head1 RATIONALE 198 | 199 | Tagging files in a way that tags are preserved cross-platform or even 200 | cross-filesystem seems to be a hard problem with no clear cut solution. 201 | 202 | =head2 Fileformat 203 | 204 | Some file formats as mp3 or pdf support saving tags inside the files but there 205 | a a lot (probably most) that don't. And even the former need special programs 206 | to do that. 207 | 208 | =head2 Filesystem 209 | 210 | Many modern file systems support tags and special meta data streams, but the 211 | tags are most likely lost when you copy files from one file system to the next. 212 | 213 | =head2 External database 214 | 215 | Keeping the tags in a external database requires a sync step after moving or 216 | deleting files. This is harder than it sounds, you probably need the keep 217 | checksums to reckognize known files after a rename. 218 | 219 | =head2 Filename 220 | 221 | All filesystems limit the length of the filename, so the number of tags 222 | you can save per file is also limited. And even before you reach the 223 | limit, the filename will be hard to read. 224 | 225 | But at least it works for all kinds of files, it not dependent on your file or 226 | operating sytemen is does not need external tools or syncing steps. 227 | 228 | =head1 SEE ALSO 229 | 230 | L, L 231 | 232 | =head1 COPYRIGHT AND LICENSE 233 | 234 | Copyright 2016 Mario Domgoergen C<< >> 235 | 236 | This program is free software: you can redistribute it and/or modify 237 | it under the terms of the GNU General Public License as published by 238 | the Free Software Foundation, either version 3 of the License, or 239 | (at your option) any later version. 240 | 241 | This program is distributed in the hope that it will be useful, 242 | but WITHOUT ANY WARRANTY; without even the implied warranty of 243 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 244 | GNU General Public License for more details. 245 | 246 | You should have received a copy of the GNU General Public License 247 | along with this program. If not, see . 248 | 249 | -------------------------------------------------------------------------------- /bin/squaretag: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | use strict; 4 | use warnings; 5 | use Pod::Usage qw(pod2usage); 6 | use Scalar::Util qw(looks_like_number); 7 | use Getopt::Long 8 | qw(GetOptionsFromArray :config bundling no_ignore_case no_getopt_compat require_order); 9 | use File::Spec::Functions qw(no_upwards catfile); 10 | 11 | ( my $app = $0 ) =~ s;.*/;;; 12 | 13 | my $extensions = '\.tar\.gz'; 14 | 15 | if ( !caller ) { 16 | run(@ARGV); 17 | exit 0; 18 | } 19 | 20 | sub run { 21 | 22 | my %options = 23 | ( separator => ',', read_configfile("$ENV{HOME}/.squaretagrc") ); 24 | 25 | GetOptionsFromArray( \@_, \%options, 'separator|s=s', 'extensions|x=s', 'recursive|r!' ) 26 | or pod2usage(); 27 | 28 | my $mode = shift; 29 | 30 | if ( $options{extensions} ) { 31 | $extensions .= '|' . join('|', map { "\Q.$_\E" } split(',', $options{extensions})); 32 | } 33 | 34 | my @rename_opts = qw(verbose|v! dry-run|n! force|f!); 35 | 36 | my %modes = ( 37 | add => { 38 | cmd => sub { 39 | my $options = shift; 40 | rename_files( $options, add_tags( $options, @_ ) ); 41 | }, 42 | minargs => 1, 43 | opt_spec => \@rename_opts, 44 | check => [ \&is_tag_file, \&check_tags ], 45 | }, 46 | remove => { 47 | cmd => sub { 48 | my $options = shift; 49 | rename_files( $options, remove_tags( $options, @_ ) ); 50 | }, 51 | minargs => 1, 52 | opt_spec => \@rename_opts, 53 | check => [ \&is_tag_file, \&check_tags ], 54 | }, 55 | rename => { 56 | cmd => sub { 57 | my $options = shift; 58 | rename_files( $options, rename_tag( $options, @_ ) ); 59 | }, 60 | minargs => 2, 61 | opt_spec => \@rename_opts, 62 | check => 63 | [ \&is_tag_file, sub { check_tags( shift, "$_[0],$_[1]" ) } ], 64 | }, 65 | clear => { 66 | cmd => sub { 67 | my $options = shift; 68 | rename_files( $options, clear( $options, @_) ); 69 | }, 70 | minargs => 0, 71 | opt_spec => \@rename_opts, 72 | }, 73 | sort => { 74 | cmd => sub { 75 | my $options = shift; 76 | rename_files( $options, sort_tags( $options, @_ ) ); 77 | }, 78 | minargs => 0, 79 | opt_spec => \@rename_opts, 80 | }, 81 | search => { 82 | cmd => sub { print $_, "\n" for @{ search_tags(@_) } }, 83 | opt_spec => ['implicit|I=s'], 84 | minargs => 1 85 | }, 86 | ## Deprecated 87 | untagged => { 88 | cmd => sub { shift; print $_, "\n" for @{ find_untagged(@_) } }, 89 | minargs => 0 90 | }, 91 | list => { 92 | cmd => sub { print_tag_list( list_tags(@_) ) }, 93 | minargs => 0 94 | }, 95 | ); 96 | 97 | if ( $mode && $modes{$mode} ) { 98 | my $cmd = $modes{$mode}->{cmd}; 99 | my $minargs = $modes{$mode}->{minargs}; 100 | 101 | if ( defined $minargs && @_ < $minargs ) { 102 | pod2usage(1); 103 | } 104 | 105 | my $opt_spec = $modes{$mode}->{opt_spec}; 106 | 107 | if ($opt_spec) { 108 | GetOptionsFromArray( \@_, \%options, @$opt_spec ) 109 | or pod2usage(1); 110 | } 111 | 112 | if ( my $checks = $modes{$mode}->{check} ) { 113 | for my $check (@$checks) { 114 | $check->( \%options, @_ ); 115 | } 116 | } 117 | 118 | $cmd->( \%options, @_ ); 119 | } 120 | else { 121 | pod2usage(1); 122 | } 123 | return; 124 | } 125 | 126 | sub file_iterator { 127 | my ( $recursive, @files ) = @_; 128 | if ( !@files ) { 129 | push @files, '.'; 130 | } 131 | return sub { 132 | FILE: 133 | while ( my $file = shift @files ) { 134 | if ( -d $file ) { 135 | if ($recursive or $file eq '.') { 136 | opendir( my $dh, $file ) 137 | or die "Can't recurise into $file\n"; 138 | my @new_files = no_upwards( readdir($dh) ); 139 | unshift @files, 140 | sort map { catfile( $file, $_ ) } @new_files; 141 | } 142 | next FILE; 143 | } 144 | 145 | # TODO handle symlink loops 146 | return $file; 147 | } 148 | return; 149 | }; 150 | } 151 | 152 | sub add_tags { modify( shift, shift, '+', @_ ) } 153 | sub remove_tags { modify( shift, shift, '-', @_ ) } 154 | 155 | sub is_tag_file { 156 | my ( $options, $tag ) = @_; 157 | pod2usage( -msg => 'Tag is also a file.', -exit => 1 ) 158 | if -e $tag && !$options->{force}; 159 | } 160 | 161 | sub check_tags { 162 | my ( $options, $tags ) = @_; 163 | my $sep = $options->{separator} || ','; 164 | for my $tag ( split( $sep, $tags ) ) { 165 | next if $tag =~ /^\s*$/; 166 | if ( $tag !~ /^\w+(?:=.+)?[+-]?$/ ) { 167 | pod2usage( -msg => "Invalid tag $tag.", -exit => 1 ); 168 | } 169 | } 170 | return; 171 | } 172 | 173 | sub print_tag_list { 174 | my ($tags) = @_; 175 | print $_, " ", $tags->{$_}, "\n" for sort keys %$tags; 176 | } 177 | 178 | sub rename_files { 179 | my ( $options, $ops ) = @_; 180 | for my $op (@$ops) { 181 | my ( $old, $new ) = @$op; 182 | next if $old eq $new; 183 | if ( !-e $old && !-l $old ) { 184 | warn "Skip missing file $old.\n"; 185 | next; 186 | } 187 | if ( -e $new || -l $new ) { 188 | warn "Skip moving $old to $new: File already exists.\n"; 189 | next; 190 | } 191 | if ( $options->{'dry-run'} || $options->{verbose} ) { 192 | print "$old -> $new\n"; 193 | next if $options->{'dry-run'}; 194 | } 195 | rename $old, $new 196 | or warn "Can't move $old to $new: $!\n"; 197 | } 198 | return; 199 | } 200 | 201 | sub modify { 202 | my $options = ref $_[0] eq 'HASH' ? shift : {}; 203 | my ( $tag_spec, $default, @files ) = @_; 204 | my ( @add, @remove ); 205 | 206 | $default ||= '+'; 207 | my $sep = $options->{separator} || ','; 208 | 209 | for ( split( $sep, $tag_spec ) ) { 210 | next if /^\s*$/; 211 | if (/^(.+)-$/) { 212 | push @remove, $1; 213 | } 214 | elsif (/^(.+)\+$/) { 215 | push @add, $1; 216 | } 217 | elsif ( $default eq '+' ) { 218 | push @add, $_; 219 | } 220 | elsif ( $default eq '-' ) { 221 | push @remove, $_; 222 | } 223 | } 224 | 225 | if ( !@add && !@remove ) { 226 | return []; 227 | } 228 | 229 | my @ops; 230 | 231 | my $iter = file_iterator( $options->{recursive}, @files ); 232 | 233 | FILE: 234 | while ( my $file = $iter->() ) { 235 | my ( $base, $tags, $ext ) = split_file($file); 236 | 237 | my @tags = split( $sep, $tags ); 238 | 239 | if ( !@tags and !@add ) { 240 | next FILE; 241 | } 242 | 243 | push @tags, @add; 244 | my %tags; 245 | for my $tag (@tags) { 246 | my ( $key, $val ) = split( /=/, $tag, 2 ); 247 | $tags{$key} = $val; 248 | } 249 | 250 | for my $tag (@remove) { 251 | my ( $key, $val ) = split( /=/, $tag, 2 ); 252 | if ( defined $val ) { 253 | if ( defined $tags{$key} and $tags{$key} eq $val ) { 254 | delete $tags{$key}; 255 | } 256 | } 257 | delete $tags{$tag}; 258 | } 259 | @tags = sort keys %tags; 260 | 261 | my $new_file; 262 | if (@tags) { 263 | @tags = map { defined $tags{$_} ? "$_=$tags{$_}" : $_ } @tags; 264 | $new_file = "$base\[" . join( $sep, @tags ) . "\]$ext"; 265 | } 266 | else { 267 | $new_file = "$base$ext"; 268 | } 269 | 270 | next if $file eq $new_file; 271 | 272 | push @ops, [ $file, $new_file ]; 273 | } 274 | return \@ops; 275 | } 276 | 277 | sub clear { 278 | my $options = ref $_[0] eq 'HASH' ? shift : {}; 279 | my (@files) = @_; 280 | my @ops; 281 | my $iter = file_iterator( $options->{recursive}, @files ); 282 | while ( my $file = $iter->() ) { 283 | my ( $base, $tags, $ext ) = split_file($file); 284 | my $new_file = "$base$ext"; 285 | push @ops, [ $file, $new_file ]; 286 | } 287 | return \@ops; 288 | } 289 | 290 | sub find_untagged { 291 | my $options = ref $_[0] eq 'HASH' ? shift : {}; 292 | my @files = @_; 293 | my $iter = file_iterator( $options->{recursive}, @files ); 294 | my @found; 295 | while ( my $file = $iter->() ) { 296 | my ( $base, $tags, $ext ) = split_file($file); 297 | if ( !$tags ) { 298 | push @found, $file; 299 | } 300 | } 301 | return \@found; 302 | } 303 | 304 | sub sort_tags { 305 | my $options = ref $_[0] eq 'HASH' ? shift : {}; 306 | my $sep = $options->{separator} || ','; 307 | my $iter = file_iterator( $options->{recursive}, @_ ); 308 | my @ops; 309 | while ( my $file = $iter->() ) { 310 | my ( $base, $tags, $ext ) = split_file($file); 311 | next if !$tags; 312 | my $new_file = 313 | "$base\[" . join( $sep, sort split( $sep, $tags ) ) . "\]$ext"; 314 | push @ops, [ $file, $new_file ]; 315 | } 316 | return \@ops; 317 | } 318 | 319 | sub search_tags { 320 | my $options = ref $_[0] eq 'HASH' ? shift : {}; 321 | my ( $tag_spec, @files ) = @_; 322 | my $sep = $options->{separator} || ','; 323 | my $implicit_re = $options->{implicit}; 324 | my @found; 325 | my $check = compile_search($tag_spec); 326 | my $iter = file_iterator( $options->{recursive}, @files ); 327 | FILE: 328 | 329 | while ( my $file = $iter->() ) { 330 | my ( $base, $tags, $ext ) = split_file($file); 331 | 332 | my ( %tags, %properties ); 333 | 334 | $properties{tagged} = 1 if $tags; 335 | 336 | if ( $implicit_re && "$base.$ext" =~ /$implicit_re/o ) { 337 | $properties{implicit} = 1; 338 | %tags = %+; 339 | } 340 | 341 | my @tags = split( $sep, $tags ); 342 | for my $tag (@tags) { 343 | my ( $key, $val ) = split( /=/, $tag, 2 ); 344 | $tags{$key} = $val; 345 | } 346 | push @found, $file if $check->( \%tags, \%properties ); 347 | } 348 | return \@found; 349 | } 350 | 351 | sub compile_search { 352 | my $search = shift; 353 | my $code = 'sub { my ($tags,$properties) = @_;'; 354 | while (1) { 355 | if ( $search =~ /\G ( && | \|\| | \( | \) | ! )/gcx ) { 356 | $code .= $1; 357 | } 358 | elsif ( $search =~ /\G (implicit|tagged)\(\) /gcx ) { 359 | $code .= qq{ \$properties->{$1} }; 360 | } 361 | elsif ( $search =~ /\G (\w+) \s* (<|>|=|~) \s* $/gcx ) { 362 | die "No operand on right side of $1.\n"; 363 | } 364 | elsif ( $search =~ /\G (\w+) \s* = \s* (\w+)/gcx ) { 365 | $code .= qq{ defined \$tags->{$1} && } . qq{\$tags->{$1} eq "$2"}; 366 | } 367 | elsif ( $search =~ /\G (\w+) \s* ~ \s* (\w+)/gcx ) { 368 | $code .= 369 | qq{ defined \$tags->{$1} && index(\$tags->{$1},"$2") != -1 }; 370 | } 371 | elsif ( $search =~ /\G (\w+) \s* (<|>) \s* ([^0-9]+)/gcx ) { 372 | die "Operand $3 isn't numeric in numerical comparison.\n"; 373 | } 374 | elsif ( $search =~ /\G (\w+) \s* (=|<|>) \s* ([0-9]+)/gcx ) { 375 | $code .= qq{ defined \$tags->{$1} && \$tags->{$1} $2 "$3"}; 376 | } 377 | elsif ( $search =~ /\G (\w+) /gcx ) { 378 | $code .= " exists \$tags->{$1}"; 379 | } 380 | elsif ( $search =~ /\G \s+ /gcx ) { 381 | redo; 382 | } 383 | elsif ( $search =~ /\G (.)/gcx ) { 384 | die "Error at $search\n" . ( ' ' x ( 8 + pos($search) ) ) . "^\n"; 385 | } 386 | else { 387 | last; 388 | } 389 | } 390 | $code .= '}'; 391 | my $sub = eval $code; 392 | die "$@" if "$@"; 393 | return $sub; 394 | } 395 | 396 | sub list_tags { 397 | my $options = ref $_[0] eq 'HASH' ? shift : {}; 398 | my (@files) = @_; 399 | my $sep = $options->{separator} || ','; 400 | my %tags; 401 | my $iter = file_iterator( $options->{recursive}, @files ); 402 | while ( my $file = $iter->() ) { 403 | my ( $base, $tags, $ext ) = split_file($file); 404 | my @tags = split( $sep, $tags ); 405 | $tags{$_}++ for @tags; 406 | } 407 | return \%tags; 408 | } 409 | 410 | sub rename_tag { 411 | my $options = ref $_[0] eq 'HASH' ? shift : {}; 412 | my ( $old, $new, @files ) = @_; 413 | my $sep = $options->{separator} || ','; 414 | return [] if $old eq $new; 415 | my @ops; 416 | my $iter = file_iterator( $options->{recursive}, @files ); 417 | FILE: 418 | while ( my $file = $iter->() ) { 419 | my ( $base, $tags, $ext ) = split_file($file); 420 | my @tags = split( $sep, $tags ); 421 | my %tags = map { $_ => 1 } @tags; 422 | if ( exists $tags{$old} ) { 423 | delete $tags{$old}; 424 | $tags{$new} = 1; 425 | @tags = sort keys %tags; 426 | my $new_file = "$base\[" . join( $sep, @tags ) . "\]$ext"; 427 | push @ops, [ $file, $new_file ]; 428 | } 429 | } 430 | return \@ops; 431 | } 432 | 433 | sub split_file { 434 | my $file = shift; 435 | my ( $base, $tags, $ext ); 436 | ( $base, $ext ) = $file =~ m/^(.+?)($extensions|\.[^.]*$|$)/; 437 | ( $base, $tags ) = $base =~ m/^(.*?)(?:\[([^[]*)\]$|$)/; 438 | if ( !$base ) { 439 | $base = "[$tags]"; 440 | $tags = ''; 441 | } 442 | $tags //= ''; 443 | return ( $base, $tags, $ext ); 444 | } 445 | 446 | sub read_configfile { 447 | my $file = shift; 448 | return if !-e $file; 449 | open( my $fh, '<', $file ) 450 | or die "Can't open configuration file $file: !\n"; 451 | my %config; 452 | 453 | while (<$fh>) { 454 | chomp; # no newline 455 | s/#.*//; # no comments 456 | s/^\s+//; # no leading white 457 | s/\s+$//; # no trailing white 458 | next unless length; # anything left? 459 | my ( $key, $value ) = split( /\s*=\s*/, $_, 2 ); 460 | $value =~ s/^"(.*)"/$1/; 461 | $config{$key} = $value; 462 | } 463 | return %config; 464 | } 465 | 466 | 1; 467 | 468 | __END__ 469 | 470 | =pod 471 | 472 | =for html Coverage Status 473 | 474 | =head1 NAME 475 | 476 | squaretag - tag files by using filenames 477 | 478 | =head1 SYNOPSIS 479 | 480 | squaretag [-s SEP] [-r] add [-v] [-n] [-f] TAG [[FILES...]] 481 | squaretag [-s SEP] [-r] remove [-v] [-n] [-f] TAG [[FILES...]] 482 | squaretag [-r] clear [-v] [-n] [-f] [[FILES...]] 483 | squaretag [-s SEP] [-r] rename [-v] [-n] [-f] OLD_TAG NEW_TAG [[FILES...]] 484 | squaretag [-s SEP] [-r] list [[FILES...]] 485 | squaretag [-s SEP] [-r] search [-I REGEX] SEARCH [[FILES...]] 486 | 487 | =head1 DESCRIPTION 488 | 489 | Squaretag helps you to organize your files by tagging them. The tags 490 | are saved in the filename by adding all tags in square brackets either 491 | at the end of the filename or just before the last dot. 492 | 493 | =head1 MAINTENANCE MODE 494 | 495 | This project is in maintenance mode. That means there will be no more 496 | active feature development. 497 | 498 | =head1 EXAMPLES 499 | 500 | Suppose the current directory contains the following files: 501 | 502 | $ squaretag search '!tagged()' 503 | picture01.jpg 504 | picture02 505 | 506 | Now you want to add the tag I to all pictures. 507 | 508 | $ squaretag add -v family 509 | picture01.jpg -> picture01[family].jpg 510 | picture02 -> picture02[family] 511 | 512 | Files can have multiple tags 513 | 514 | $ squaretag add -v myself picture01[family].jpg 515 | picture01[family].jpg -> picture01[family,myself].jpg 516 | 517 | You can rename single tags 518 | 519 | $ squaretag rename -v myself me picture01[family,myself].jpg 520 | picture01[family,myself].jpg -> picture01[family,me].jpg 521 | 522 | Or delete a tag 523 | 524 | $ squaretag remove me -v picture01[family,me].jpg 525 | picture01[family,me].jpg -> picture01[family].jpg 526 | 527 | And what would tags be good for if you couldn't search for them 528 | 529 | $ squaretag search 'family && !me' 530 | picture02[family] 531 | 532 | And if you have enough, you can simple clear all tags 533 | 534 | $ squaretag clear -v 535 | picture01[family].jpg -> picture01.jpg 536 | picture02[family] -> picture02 537 | 538 | Tags can also have values: 539 | 540 | $ squaretag add read=2016 book.epub 541 | $ squaretag search 'read>2010' 542 | books[read=2016].epub 543 | $ squaretag search 'read<2010' 544 | $ squaretag search 'read=2016' 545 | books[read=2016].epub 546 | 547 | =head1 COMMANDS 548 | 549 | =over 4 550 | 551 | =item add TAG [FILES...] 552 | 553 | Add TAG to FILES. TAG is a comma seperated list of tags to add. If 554 | a tag has a suffix of I<-> this tag will be removed from the file. 555 | 556 | =item remove TAG [FILES...] 557 | 558 | Remove TAG from FILES. TAG is a comma seperated list of tags to remove. If 559 | a tag has a suffix of I<+> this tag will be added to the file. 560 | 561 | =item search SPEC [FILES...] 562 | 563 | List all FILES that match the search SPEC. SPEC can contain tags and 564 | the usual boolean operators. 565 | 566 | For example: 567 | 568 | read && good 569 | !read || (not_read && prio ) 570 | 571 | There are four additional operators I>, I>, I<=> and I<~> 572 | to handle tags with values. 573 | 574 | The function I returns true if the file has any explicit tags, 575 | I if it has any implicit tags. 576 | 577 | =over 4 578 | 579 | =item I<=> 580 | 581 | Compares if operands are string-equal. 582 | 583 | =item I>, I> 584 | 585 | Numerical less-than or more-than comparison. 586 | 587 | =item I<~> 588 | 589 | Checks if left operand contains right operand as substring. 590 | 591 | =back 592 | 593 | =item clear [FILES...] 594 | 595 | Remove all tags from FILES. 596 | 597 | =item sort [FILES...] 598 | 599 | Sort tags in all FILES with tags. 600 | 601 | =item rename OLD_TAG NEW_TAG [FILES...] 602 | 603 | Rename OLD_TAG in NEW_TAG in all FILES. 604 | 605 | =item list [FILES...] 606 | 607 | List and count all tags for FILES. The tags are sorted in descending 608 | order of frequency. 609 | 610 | =back 611 | 612 | =head1 OPTIONS 613 | 614 | =over 4 615 | 616 | =item --verbose|-v 617 | 618 | Print what squaretag does. 619 | 620 | =item --dry-run|-n 621 | 622 | Just print which files squaretag would rename without doing it. 623 | 624 | =item --force 625 | 626 | Ignore warnings about tags that look like files and overwriting existing 627 | files. 628 | 629 | =item --separator=SEP|-s=SEP 630 | 631 | The string to separate tags. Defaults to I<,>. 632 | 633 | =item --recursive|-r 634 | 635 | Recurse into subdirectories. 636 | 637 | =item --extensions=LIST 638 | 639 | A comma separated list of extensions that are recognized by 640 | squartag. The leading dot is implied. This is only needed for extensions 641 | with a dot in them, normal extensions are handled by squartag without 642 | the need to specify them. 643 | 644 | =item --implicit=REGEX|-I=REGEX 645 | 646 | Apply regex to the basename of the file without its tags. All matched 647 | capture groups are added as tags with less precedence than the explicit 648 | tags. 649 | 650 | For example, if regex is '^(?(.+?),' and the file is called 651 | 'Pratchett, Terry - Color of Magic.epub', a tag I with the value 652 | of I is added. 653 | 654 | =back 655 | 656 | =head1 CONFIGURATION FILE 657 | 658 | squaretag will try to read I<$HOME/.squaretagrc> on startup. Empty lines 659 | are ignored, as is everything after I<#>. Everything else is a key-value 660 | combination separated by a equal sign. All options can be set. Quoting 661 | is optional, except to save trailings whitespace. 662 | 663 | separator = " " # by space! 664 | force = 1 665 | 666 | =head1 RATIONALE 667 | 668 | Tagging files in a way that tags are preserved cross-platform or even 669 | cross-filesystem seems to be a hard problem with no clear cut solution. 670 | 671 | =head2 Fileformat 672 | 673 | Some file formats as mp3 or pdf support saving tags inside the files but there 674 | a a lot (probably most) that don't. And even the former need special programs 675 | to do that. 676 | 677 | =head2 Filesystem 678 | 679 | Many modern file systems support tags and special meta data streams, but the 680 | tags are most likely lost when you copy files from one file system to the next. 681 | 682 | =head2 External database 683 | 684 | Keeping the tags in a external database requires a sync step after moving or 685 | deleting files. This is harder than it sounds, you probably need the keep 686 | checksums to reckognize known files after a rename. 687 | 688 | =head2 Filename 689 | 690 | All filesystems limit the length of the filename, so the number of tags 691 | you can save per file is also limited. And even before you reach the 692 | limit, the filename will be hard to read. 693 | 694 | But at least it works for all kinds of files, it not dependent on your file or 695 | operating sytemen is does not need external tools or syncing steps. 696 | 697 | =head1 SEE ALSO 698 | 699 | L, L 700 | 701 | =head1 COPYRIGHT AND LICENSE 702 | 703 | Copyright 2016 Mario Domgoergen C<< >> 704 | 705 | This program is free software: you can redistribute it and/or modify 706 | it under the terms of the GNU General Public License as published by 707 | the Free Software Foundation, either version 3 of the License, or 708 | (at your option) any later version. 709 | 710 | This program is distributed in the hope that it will be useful, 711 | but WITHOUT ANY WARRANTY; without even the implied warranty of 712 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 713 | GNU General Public License for more details. 714 | 715 | You should have received a copy of the GNU General Public License 716 | along with this program. If not, see . 717 | 718 | =cut 719 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | squaretag Copyright (C) 2016 Mario Domgoergen 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------