make proto
-This patch adds the ability to merge rules into your excludes/includes
-using a ". FILE" idiom. If you specify a name with a preceding -p
-option, that filename will be looked for in every subdirectory that
-rsync visits, and the rules found in that subdirectory's file will
-affect that dir and its subdirs.
+This patch adds the --filter option, which implements an improved set of
+include/exclude rules:
+
+ . SINGLE-INSTANCE_MERGE_FILE
+ : PER-DIRECTORY_MERGE_FILE
+ - exclude-pattern
+ + include-pattern
+
+Note that the prefix for a filter rule is NOT optional, and that the
+separating space can be replaced by an equal-sign (=) or an underscore (_),
+if desired. There are also optional modifiers that can be specified for
+the merge-file rules.
+
+A per-directory merge file is one that will be looked for in every
+sub-directory that rsync visits, and the rules found in that sub-
+directory's file will affect that dir and (if desired) its subdirs.
For example:
- rsync -av --exclude='. -p .excl' from/ to
+ rsync -av --filter :_.rules from/ to
-The above will look for a file named ".excl" in every directory of the
-hierarchy that rsync visits, and it will exclude (by default) names
-based on the rules found therein. If one of the .excl files contains
-this:
+The above will look for a file named ".rules" in every directory of the
+hierarchy that rsync visits, and it will filter names based on the rules
+found therein. If one of the .rules files contains this:
+ *.c
- . -p .excl2
- . .excl3
- *.o
- /foobar
+ : .rules2
+ . .rules3
+ - *.o
+ - /foobar
-Then the file ".excl2" will also be read in from the current dir and all
-its subdirs (due to the -p option). The file ".excl3" would just be
-read in from the current dir. The exclusion of "foobar" will only
-happen in that .excl file's directory because the rule is anchored (so
-that's how you can make rules local instead of inherited).
+Then the file ".rules2" will also be read in from the current dir and all
+its subdirs. The file ".rules3" would just be read in from the current dir
+only. The exclusion of "foobar" will only happen in that .rules file's
+directory because the rule is anchored, which is one way to make a rule
+local instead of inherited (see also the 'n' modifier).
..wayne..
---- orig/clientserver.c 2004-08-02 02:29:16
-+++ clientserver.c 2004-08-10 15:44:15
-@@ -48,12 +48,14 @@ extern int no_detach;
+--- orig/clientserver.c 2005-01-22 22:48:52
++++ clientserver.c 2005-01-16 23:33:02
+@@ -49,12 +49,14 @@ extern int no_detach;
extern int default_af_hint;
extern char *bind_address;
extern struct exclude_list_struct server_exclude_list;
/**
* Run a client connected to an rsyncd. The alternative to this
* function for remote-shell connections is do_cmd().
-@@ -300,26 +302,28 @@ static int rsync_module(int f_in, int f_
+@@ -310,26 +312,33 @@ static int rsync_module(int f_in, int f_
/* TODO: Perhaps take a list of gids, and make them into the
* supplementary groups. */
+ module_dirlen = strlen(lp_path(i));
+ set_excludes_dir(lp_path(i), module_dirlen);
+ }
++
++ p = lp_filter(i);
++ add_exclude(&server_exclude_list, p,
++ XFLG_WORD_SPLIT | XFLG_ABS_PATH);
p = lp_include_from(i);
add_exclude_file(&server_exclude_list, p,
- XFLG_FATAL_ERRORS | XFLG_DEF_INCLUDE);
-+ XFLG_FATAL_ERRORS | XFLG_DEF_INCLUDE | XFLG_ABS_PATH);
++ XFLG_FATAL_ERRORS | XFLG_ABS_PATH | XFLG_DEF_INCLUDE);
p = lp_include(i);
add_exclude(&server_exclude_list, p,
- XFLG_WORD_SPLIT | XFLG_DEF_INCLUDE);
-+ XFLG_WORD_SPLIT | XFLG_DEF_INCLUDE | XFLG_ABS_PATH);
++ XFLG_WORD_SPLIT | XFLG_ABS_PATH | XFLG_DEF_INCLUDE);
p = lp_exclude_from(i);
add_exclude_file(&server_exclude_list, p,
- XFLG_FATAL_ERRORS);
-+ XFLG_FATAL_ERRORS | XFLG_ABS_PATH);
++ XFLG_FATAL_ERRORS | XFLG_ABS_PATH | XFLG_DEF_EXCLUDE);
p = lp_exclude(i);
- add_exclude(&server_exclude_list, p, XFLG_WORD_SPLIT);
-
- exclude_path_prefix = NULL;
-+ add_exclude(&server_exclude_list, p, XFLG_WORD_SPLIT | XFLG_ABS_PATH);
++ add_exclude(&server_exclude_list, p,
++ XFLG_WORD_SPLIT | XFLG_ABS_PATH | XFLG_DEF_EXCLUDE);
log_init();
---- orig/exclude.c 2004-10-06 00:12:16
-+++ exclude.c 2004-08-13 07:40:08
-@@ -30,13 +30,69 @@ extern int verbose;
+--- orig/exclude.c 2005-01-22 22:48:52
++++ exclude.c 2005-01-23 07:33:21
+@@ -30,15 +30,68 @@ extern int verbose;
extern int eol_nulls;
extern int list_only;
extern int recurse;
+extern int io_error;
+extern int sanitize_paths;
++extern int protocol_version;
extern char curr_dir[];
+extern unsigned int curr_dir_len;
-struct exclude_list_struct local_exclude_list = { 0, 0, "per-dir .cvsignore " };
struct exclude_list_struct server_exclude_list = { 0, 0, "server " };
-char *exclude_path_prefix = NULL;
-+
-+struct mergelist_save_struct {
-+ struct exclude_list_struct *array;
-+ int count;
-+};
-+
+
+-/** Build an exclude structure given an exclude pattern. */
+/* The dirbuf is set by push_local_excludes() to the current subdirectory
+ * relative to curr_dir that is being processed. The path always has a
+ * trailing slash appended, and the variable dirbuf_len contains the length
+ * head -> Parent1 -> Parent2 -> NULL head -> L1 -> L2 -> P1 -> P2 -> NULL
+ * tail -> NULL tail ---------^
+ *
-+ * This means that anyone wanting to traverse the whole list to USE it just
++ * This means that anyone wanting to traverse the whole list to use it just
+ * needs to start at the head and use the "next" pointers until it goes
+ * NULL. To add new local content, we insert the item after the tail item
+ * and update the tail (obviously, if "tail" was NULL, we insert it at the
+ * the list for a new local dir, we just save off the exclude_list_struct
+ * values (so we can pop back to them later) and set the tail to NULL.
+ */
-
- /** Build an exclude structure given an exclude pattern. */
++
++/* Build an exclude structure given an exclude pattern. The value in "pat"
++ * is not null-terminated. */
static void make_exclude(struct exclude_list_struct *listp, const char *pat,
-@@ -46,23 +102,50 @@ static void make_exclude(struct exclude_
+ unsigned int pat_len, unsigned int mflags)
+ {
+@@ -46,23 +99,45 @@ static void make_exclude(struct exclude_
const char *cp;
unsigned int ex_len;
+ if (verbose > 2) {
-+ rprintf(FINFO, "[%s] add_exclude(%.*s, %s%s%sclude)\n",
-+ who_am_i(), (int)pat_len, pat, listp->debug_type,
-+ mflags & MATCHFLG_MERGE_FILE ? "FILE " : "",
-+ mflags & MATCHFLG_INCLUDE ? "in" : "ex");
++ rprintf(FINFO, "[%s] add_exclude(%.*s, %s%s)\n",
++ who_am_i(), (int)pat_len, pat,
++ mflags & MATCHFLG_MERGE_FILE ? "per-dir-merge"
++ : mflags & MATCHFLG_INCLUDE ? "include" : "exclude",
++ listp->debug_type);
+ }
+
+ if (mflags & MATCHFLG_MERGE_FILE) {
+ int i;
-+ /* If the local include file was already mentioned, don't
++ /* If the local merge file was already mentioned, don't
+ * add it again. */
+ for (i = 0; i < mergelist_cnt; i++) {
+ struct exclude_struct *ex = mergelist_parents[i];
+ && memcmp(ex->pattern, pat, pat_len) == 0)
+ return;
+ }
-+ if ((pat_len == 10 || (pat_len > 10 && pat[pat_len-11] == '/'))
-+ && strncmp(pat+pat_len-10, ".cvsignore", 10) == 0) {
-+ mflags |= MATCHFLG_CVSIGNORE;
-+ mflags &= ~MATCHFLG_INCLUDE;
-+ } else
-+ mflags &= ~MATCHFLG_CVSIGNORE;
+ }
+
ret = new(struct exclude_struct);
strlcpy(ret->pattern + ex_len, pat, pat_len + 1);
pat_len += ex_len;
-@@ -81,14 +164,40 @@ static void make_exclude(struct exclude_
+@@ -81,14 +156,40 @@ static void make_exclude(struct exclude_
mflags |= MATCHFLG_DIRECTORY;
}
+ cp++;
+ else
+ cp = ret->pattern;
-+ if (asprintf(&lp->debug_type, "per-dir %s ", cp) < 0)
++ if (asprintf(&lp->debug_type, " (per-dir %s)", cp) < 0)
+ out_of_memory("make_exclude");
+ ret->u.mergelist = lp;
+ if (mergelist_cnt == mergelist_size) {
listp->tail->next = ret;
listp->tail = ret;
}
-@@ -96,22 +205,267 @@ static void make_exclude(struct exclude_
+@@ -96,22 +197,263 @@ static void make_exclude(struct exclude_
static void free_exclude(struct exclude_struct *ex)
{
+ if (ex->match_flags & MATCHFLG_MERGE_FILE) {
+ free(ex->u.mergelist->debug_type);
+ free(ex->u.mergelist);
++ mergelist_cnt--;
+ }
free(ex->pattern);
free(ex);
+ dirbuf_len = y - dirbuf;
+ strlcpy(x, ex->pattern, MAXPATHLEN - (x - buf));
+ add_exclude_file(lp, buf, flags | XFLG_ABS_PATH);
-+ if (ex->match_flags & MATCHFLG_CVSIGNORE)
-+ lp->head = NULL; /* CVS doesn't inherit rules. */
++ if (ex->match_flags & MATCHFLG_NO_INHERIT)
++ lp->head = NULL;
+ lp->tail = NULL;
+ strlcpy(y, save, MAXPATHLEN);
+ while ((*x++ = *y++) != '/') {}
+ * into dirbuf so that we can easily append a file name on the end. */
+void *push_local_excludes(const char *dir, unsigned int dirlen)
+{
-+ struct mergelist_save_struct *push;
-+ struct exclude_list_struct *ap;
++ struct exclude_list_struct *ap, *push;
+ int i;
+
+ set_excludes_dir(dir, dirlen);
+
-+ if (!(push = new_array(struct mergelist_save_struct, 1)))
-+ out_of_memory("push_local_excludes");
-+
-+ push->count = mergelist_cnt;
-+ push->array = new_array(struct exclude_list_struct, mergelist_cnt);
-+ if (!push->array)
++ push = new_array(struct exclude_list_struct, mergelist_cnt);
++ if (!push)
+ out_of_memory("push_local_excludes");
+
-+ for (i = 0, ap = push->array; i < mergelist_cnt; i++) {
++ for (i = 0, ap = push; i < mergelist_cnt; i++) {
+ memcpy(ap++, mergelist_parents[i]->u.mergelist,
+ sizeof (struct exclude_list_struct));
+ }
+ for (i = 0; i < mergelist_cnt; i++) {
+ struct exclude_struct *ex = mergelist_parents[i];
+ struct exclude_list_struct *lp = ex->u.mergelist;
-+ int flags;
++ int flags = 0;
+
+ if (verbose > 2) {
-+ rprintf(FINFO, "[%s] pushing %sexclude list\n",
++ rprintf(FINFO, "[%s] pushing exclude list%s\n",
+ who_am_i(), lp->debug_type);
+ }
+
-+ if (ex->match_flags & MATCHFLG_CVSIGNORE) {
-+ lp->head = NULL; /* CVS doesn't inherit rules. */
-+ flags = XFLG_WORD_SPLIT | XFLG_WORDS_ONLY;
-+ } else {
-+ flags = ex->match_flags & MATCHFLG_INCLUDE
-+ ? XFLG_DEF_INCLUDE : 0;
-+ }
+ lp->tail = NULL; /* Switch any local rules to inherited. */
++ if (ex->match_flags & MATCHFLG_NO_INHERIT)
++ lp->head = NULL;
++ if (ex->match_flags & MATCHFLG_WORD_SPLIT)
++ flags |= XFLG_WORD_SPLIT;
++ if (ex->match_flags & MATCHFLG_NO_PREFIXES)
++ flags |= XFLG_NO_PREFIXES;
++ if (ex->match_flags & MATCHFLG_INCLUDE)
++ flags |= XFLG_DEF_INCLUDE;
++ else if (ex->match_flags & MATCHFLG_NO_PREFIXES)
++ flags |= XFLG_DEF_EXCLUDE;
+
+ if (ex->match_flags & MATCHFLG_FINISH_SETUP) {
+ ex->match_flags &= ~MATCHFLG_FINISH_SETUP;
+
+void pop_local_excludes(void *mem)
+{
-+ struct mergelist_save_struct *pop = (struct mergelist_save_struct*)mem;
-+ struct exclude_list_struct *ap;
++ struct exclude_list_struct *ap, *pop = (struct exclude_list_struct*)mem;
+ int i;
+
+ for (i = mergelist_cnt; i-- > 0; ) {
+ struct exclude_list_struct *lp = ex->u.mergelist;
+
+ if (verbose > 2) {
-+ rprintf(FINFO, "[%s] popping %sexclude list\n",
++ rprintf(FINFO, "[%s] popping exclude list%s\n",
+ who_am_i(), lp->debug_type);
+ }
+
+ clear_exclude_list(lp);
+ }
+
-+ mergelist_cnt = pop->count;
-+ for (i = 0, ap = pop->array; i < mergelist_cnt; i++) {
++ for (i = 0, ap = pop; i < mergelist_cnt; i++) {
+ memcpy(mergelist_parents[i]->u.mergelist, ap++,
+ sizeof (struct exclude_list_struct));
+ }
+
-+ free(pop->array);
+ free(pop);
+}
+
static int check_one_exclude(char *name, struct exclude_struct *ex,
int name_is_dir)
{
-@@ -125,13 +479,14 @@ static int check_one_exclude(char *name,
+@@ -125,13 +467,14 @@ static int check_one_exclude(char *name,
/* If the pattern does not have any slashes AND it does not have
* a "**" (which could match a slash), then we just match the
* name portion of the path. */
name = full_name;
}
-@@ -148,9 +503,9 @@ static int check_one_exclude(char *name,
+@@ -148,9 +491,9 @@ static int check_one_exclude(char *name,
if (ex->match_flags & MATCHFLG_WILD) {
/* A non-anchored match with an infix slash and no "**"
* needs to match the last slash_cnt+1 name elements. */
for (p = name + strlen(name) - 1; p >= name; p--) {
if (*p == '/' && !--cnt)
break;
-@@ -221,6 +576,13 @@ int check_exclude(struct exclude_list_st
+@@ -202,12 +545,11 @@ static void report_exclude_result(char c
+ * case we add it back in here. */
+
+ if (verbose >= 2) {
+- rprintf(FINFO, "[%s] %scluding %s %s because of %spattern %s%s\n",
++ rprintf(FINFO, "[%s] %scluding %s %s because of pattern %s%s%s\n",
+ who_am_i(),
+ ent->match_flags & MATCHFLG_INCLUDE ? "in" : "ex",
+- name_is_dir ? "directory" : "file", name, type,
+- ent->pattern,
+- ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "");
++ name_is_dir ? "directory" : "file", name, ent->pattern,
++ ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "", type);
+ }
+ }
+
+@@ -221,6 +563,13 @@ int check_exclude(struct exclude_list_st
struct exclude_struct *ent;
for (ent = listp->head; ent; ent = ent->next) {
if (check_one_exclude(name, ent, name_is_dir)) {
report_exclude_result(name, ent, name_is_dir,
listp->debug_type);
-@@ -254,11 +616,36 @@ static const char *get_exclude_tok(const
+@@ -236,32 +585,102 @@ int check_exclude(struct exclude_list_st
+ * be '\0' terminated, so use the returned length to limit the string.
+ * Also, be sure to add this length to the returned pointer before passing
+ * it back to ask for the next token. This routine parses the "!" (list-
+- * clearing) token and (if xflags does NOT contain XFLG_WORDS_ONLY) the
++ * clearing) token and (if xflags does NOT contain XFLG_NO_PREFIXES) the
+ * +/- prefixes for overriding the include/exclude mode. The *flag_ptr
+ * value will also be set to the MATCHFLG_* bits for the current token.
+ */
+-static const char *get_exclude_tok(const char *p, unsigned int *len_ptr,
+- unsigned int *flag_ptr, int xflags)
++static const char *get_exclude_tok(const char *p, int xflags,
++ unsigned int *len_ptr, unsigned int *flag_ptr)
+ {
+ const unsigned char *s = (const unsigned char *)p;
+ unsigned int len, mflags = 0;
++ int empty_pat_is_OK = 0;
+
+ if (xflags & XFLG_WORD_SPLIT) {
+ /* Skip over any initial whitespace. */
+ while (isspace(*s))
+ s++;
+- /* Update for "!" check. */
++ /* Update to point to real start of rule. */
p = (const char *)s;
}
++ if (!*s)
++ return NULL;
- /* Is this a '+' or '-' followed by a space (not whitespace)? */
-+ /* Check for a +/-/. followed by a space (not whitespace). */
- if (!(xflags & XFLG_WORDS_ONLY)
-- && (*s == '-' || *s == '+') && s[1] == ' ') {
-+ && (*s == '-' || *s == '+' || *s == '.') && s[1] == ' ') {
- if (*s == '+')
- mflags |= MATCHFLG_INCLUDE;
-+ else if (*s == '.') {
+- if (!(xflags & XFLG_WORDS_ONLY)
++ /* Figure out what kind of a filter rule "s" is pointing at. */
++ if (!(xflags & (XFLG_DEF_INCLUDE | XFLG_DEF_EXCLUDE))) {
++ char *mods = "";
++ switch (*s) {
++ case ':':
++ mflags |= MATCHFLG_PERDIR_MERGE
++ | MATCHFLG_FINISH_SETUP;
++ /* FALL THROUGH */
++ case '.':
+ mflags |= MATCHFLG_MERGE_FILE;
-+ if (xflags & XFLG_DEF_INCLUDE)
-+ mflags |= MATCHFLG_INCLUDE;
-+ while (s[2] == '-') {
-+ s += 2;
-+ do {
-+ switch (*++s) {
-+ case 'p':
-+ mflags |= MATCHFLG_PERDIR_MERGE
-+ | MATCHFLG_FINISH_SETUP;
-+ break;
-+ case '-':
-+ if (s[1] == ' ')
-+ goto done;
-+ default:
-+ rprintf(FERROR,
-+ "invalid merge options: %s\n",
-+ p);
-+ exit_cleanup(RERR_SYNTAX);
-+ }
-+ } while (s[1] != ' ');
++ mods = "-+Cens";
++ break;
++ case '+':
++ mflags |= MATCHFLG_INCLUDE;
++ break;
++ case '-':
++ break;
++ case '!':
++ mflags |= MATCHFLG_CLEAR_LIST;
++ mods = NULL;
++ break;
++ default:
++ rprintf(FERROR, "Unknown filter rule: %s\n", p);
++ exit_cleanup(RERR_SYNTAX);
++ }
++ while (mods && *++s && *s != ' ' && *s != '=' && *s != '_') {
++ if (strchr(mods, *s) == NULL) {
++ if (xflags & XFLG_WORD_SPLIT && isspace(*s)) {
++ s--;
++ break;
++ }
++ rprintf(FERROR,
++ "unknown option '%c' in filter rule: %s\n",
++ *s, p);
++ exit_cleanup(RERR_SYNTAX);
++ }
++ switch (*s) {
++ case '-':
++ mflags |= MATCHFLG_NO_PREFIXES;
++ break;
++ case '+':
++ mflags |= MATCHFLG_NO_PREFIXES
++ | MATCHFLG_INCLUDE;
++ break;
++ case 'C':
++ empty_pat_is_OK = 1;
++ mflags |= MATCHFLG_NO_PREFIXES
++ | MATCHFLG_WORD_SPLIT
++ | MATCHFLG_NO_INHERIT;
++ break;
++ case 'e':
++ mflags |= MATCHFLG_EXCLUDE_SELF;
++ break;
++ case 'n':
++ mflags |= MATCHFLG_NO_INHERIT;
++ break;
++ case 's':
++ mflags |= MATCHFLG_WORD_SPLIT;
++ break;
+ }
+ }
-+ done:
++ if (*s)
++ s++;
++ } else if (!(xflags & XFLG_NO_PREFIXES)
+ && (*s == '-' || *s == '+') && s[1] == ' ') {
+ if (*s == '+')
+ mflags |= MATCHFLG_INCLUDE;
s += 2;
- } else if (xflags & XFLG_DEF_INCLUDE)
- mflags |= MATCHFLG_INCLUDE;
-@@ -276,6 +663,8 @@ static const char *get_exclude_tok(const
+- } else if (xflags & XFLG_DEF_INCLUDE)
+- mflags |= MATCHFLG_INCLUDE;
++ } else {
++ if (xflags & XFLG_DEF_INCLUDE)
++ mflags |= MATCHFLG_INCLUDE;
++ if (*s == '!')
++ mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
++ }
++
+ if (xflags & XFLG_DIRECTORY)
+ mflags |= MATCHFLG_DIRECTORY;
- if (*p == '!' && len == 1)
- mflags |= MATCHFLG_CLEAR_LIST;
+@@ -274,8 +693,21 @@ static const char *get_exclude_tok(const
+ } else
+ len = strlen(s);
+
+- if (*p == '!' && len == 1)
+- mflags |= MATCHFLG_CLEAR_LIST;
++ if (mflags & MATCHFLG_CLEAR_LIST) {
++ if (!(xflags & (XFLG_DEF_INCLUDE | XFLG_DEF_EXCLUDE)) && len) {
++ rprintf(FERROR,
++ "'!' rule has trailing characters: %s\n", p);
++ exit_cleanup(RERR_SYNTAX);
++ }
++ if (len > 1)
++ mflags &= ~MATCHFLG_CLEAR_LIST;
++ } else if (!len && !empty_pat_is_OK) {
++ rprintf(FERROR, "unexpected end of filter rule: %s\n", p);
++ exit_cleanup(RERR_SYNTAX);
++ }
++
+ if (xflags & XFLG_ABS_PATH)
+ mflags |= MATCHFLG_ABS_PATH;
*len_ptr = len;
*flag_ptr = mflags;
-@@ -287,7 +676,7 @@ void add_exclude(struct exclude_list_str
+@@ -287,35 +719,71 @@ void add_exclude(struct exclude_list_str
int xflags)
{
unsigned int pat_len, mflags;
if (!pattern)
return;
-@@ -295,9 +684,15 @@ void add_exclude(struct exclude_list_str
- cp = pattern;
- pat_len = 0;
+
+- cp = pattern;
+- pat_len = 0;
while (1) {
+- cp = get_exclude_tok(cp + pat_len, &pat_len, &mflags, xflags);
+- if (!pat_len)
+ /* Remember that the returned string is NOT '\0' terminated! */
- cp = get_exclude_tok(cp + pat_len, &pat_len, &mflags, xflags);
- if (!pat_len)
++ cp = get_exclude_tok(pattern, xflags, &pat_len, &mflags);
++ if (!cp)
break;
+ if (pat_len >= MAXPATHLEN) {
+ rprintf(FERROR, "discarding over-long exclude: %s\n",
+ cp);
+ continue;
+ }
++ pattern = cp + pat_len;
if (mflags & MATCHFLG_CLEAR_LIST) {
if (verbose > 2) {
-@@ -309,13 +704,24 @@ void add_exclude(struct exclude_list_str
+ rprintf(FINFO,
+- "[%s] clearing %sexclude list\n",
++ "[%s] clearing exclude list%s\n",
+ who_am_i(), listp->debug_type);
+ }
+ clear_exclude_list(listp);
continue;
}
- rprintf(FINFO, "[%s] add_exclude(%.*s, %s%sclude)\n",
- who_am_i(), (int)pat_len, cp, listp->debug_type,
- mflags & MATCHFLG_INCLUDE ? "in" : "ex");
++ if (!pat_len) {
++ cp = ".cvsignore";
++ pat_len = 10;
++ }
++
+ if (mflags & MATCHFLG_MERGE_FILE) {
+ unsigned int len = pat_len;
++ if (mflags & MATCHFLG_EXCLUDE_SELF) {
++ const char *name = strrchr(cp, '/');
++ if (name)
++ len -= ++name - cp;
++ else
++ name = cp;
++ make_exclude(listp, name, len, 0);
++ mflags &= ~MATCHFLG_EXCLUDE_SELF;
++ len = pat_len;
++ }
+ if (mflags & MATCHFLG_PERDIR_MERGE) {
+ if (parent_dirscan) {
+ if (!(p = parse_merge_name(cp, &len, module_dirlen)))
+ continue;
+ }
+ } else {
++ int flgs = XFLG_FATAL_ERRORS;
+ if (!(p = parse_merge_name(cp, &len, 0)))
+ continue;
-+ add_exclude_file(listp, p, xflags | XFLG_FATAL_ERRORS);
++ if (mflags & MATCHFLG_INCLUDE)
++ flgs |= XFLG_DEF_INCLUDE;
++ else if (mflags & MATCHFLG_NO_PREFIXES)
++ flgs |= XFLG_DEF_EXCLUDE;
++ add_exclude_file(listp, p, flgs);
+ continue;
+ }
}
}
}
-@@ -324,7 +730,7 @@ void add_exclude_file(struct exclude_lis
+@@ -324,7 +792,7 @@ void add_exclude_file(struct exclude_lis
int xflags)
{
FILE *fp;
- char line[MAXPATHLEN+3]; /* Room for "x " prefix and trailing slash. */
-+ char line[MAXPATHLEN+7]; /* Room for prefix chars and trailing slash. */
++ char line[MAXPATHLEN+11]; /* Room for prefix chars and trailing slash. */
char *eob = line + sizeof line - 1;
int word_split = xflags & XFLG_WORD_SPLIT;
-@@ -345,6 +751,12 @@ void add_exclude_file(struct exclude_lis
+@@ -338,13 +806,19 @@ void add_exclude_file(struct exclude_lis
+ if (!fp) {
+ if (xflags & XFLG_FATAL_ERRORS) {
+ rsyserr(FERROR, errno,
+- "failed to open %s file %s",
+- xflags & XFLG_DEF_INCLUDE ? "include" : "exclude",
+- fname);
++ "failed to open %sclude file %s",
++ xflags & XFLG_DEF_INCLUDE ? "in" : "ex",
++ safe_fname(fname));
+ exit_cleanup(RERR_FILEIO);
}
return;
}
+
+ if (verbose > 2) {
+ rprintf(FINFO, "[%s] add_exclude_file(%s,%d)\n",
-+ who_am_i(), fname, xflags);
++ who_am_i(), safe_fname(fname), xflags);
+ }
while (1) {
char *s = line;
-@@ -405,7 +817,21 @@ void send_exclude_list(int f)
- if (ent->match_flags & MATCHFLG_INCLUDE) {
- write_int(f, l + 2);
- write_buf(f, "+ ", 2);
-- } else if ((*p == '-' || *p == '+') && p[1] == ' ') {
-+ } else if (ent->match_flags & MATCHFLG_MERGE_FILE) {
+@@ -386,7 +860,7 @@ void send_exclude_list(int f)
+ /* This is a complete hack - blame Rusty. FIXME!
+ * Remove this hack when older rsyncs (below 2.6.4) are gone. */
+ if (list_only == 1 && !recurse)
+- add_exclude(&exclude_list, "/*/*", 0);
++ add_exclude(&exclude_list, "/*/*", XFLG_DEF_EXCLUDE);
+
+ for (ent = exclude_list.head; ent; ent = ent->next) {
+ unsigned int l;
+@@ -400,10 +874,34 @@ void send_exclude_list(int f)
+ p[l] = '\0';
+ }
+
+- if (ent->match_flags & MATCHFLG_INCLUDE) {
++ if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
+ char buf[32], *op = buf;
-+ *op++ = '.';
-+ *op++ = ' ';
-+ if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
-+ *op++ = '-';
-+ *op++ = 'p';
-+ if (*p == '-')
++ if (protocol_version < 29) {
++ rprintf(FERROR,
++ "remote rsync is too old to understand per-directory filter files.\n");
++ exit_cleanup(RERR_SYNTAX);
++ }
++ *op++ = ':';
++ if (ent->match_flags & MATCHFLG_WORD_SPLIT)
++ *op++ = 's';
++ if (ent->match_flags & MATCHFLG_NO_INHERIT)
++ *op++ = 'n';
++ if (ent->match_flags & MATCHFLG_EXCLUDE_SELF)
++ *op++ = 'e';
++ if (ent->match_flags & MATCHFLG_NO_PREFIXES) {
++ if (ent->match_flags & MATCHFLG_INCLUDE)
++ *op++ = '+';
++ else
+ *op++ = '-';
-+ *op++ = ' ';
+ }
++ *op++ = ' ';
+ write_int(f, l + (op - buf));
+ write_buf(f, buf, op - buf);
-+ } else if ((*p == '-' || *p == '+' || *p == '.')
-+ && p[1] == ' ') {
++ } else if (ent->match_flags & MATCHFLG_INCLUDE) {
+ write_int(f, l + 2);
+ write_buf(f, "+ ", 2);
+- } else if (*p == '-' || *p == '+') {
++ } else if (protocol_version >= 29
++ || ((*p == '-' || *p == '+') && p[1] == ' ')) {
write_int(f, l + 2);
write_buf(f, "- ", 2);
} else
-@@ -446,6 +872,7 @@ void add_cvs_excludes(void)
+@@ -417,14 +915,15 @@ void send_exclude_list(int f)
+
+ void recv_exclude_list(int f)
+ {
+- char line[MAXPATHLEN+3]; /* Room for "x " prefix and trailing slash. */
++ char line[MAXPATHLEN+11]; /* Room for prefix and trailing slash. */
++ unsigned int xflags = protocol_version >= 29 ? 0 : XFLG_DEF_EXCLUDE;
+ unsigned int l;
+
+ while ((l = read_int(f)) != 0) {
+ if (l >= sizeof line)
+ overflow("recv_exclude_list");
+ read_sbuf(f, line, l);
+- add_exclude(&exclude_list, line, 0);
++ add_exclude(&exclude_list, line, xflags);
+ }
+ }
+
+@@ -441,18 +940,18 @@ static char default_cvsignore[] =
+
+ void add_cvs_excludes(void)
+ {
++ static unsigned int cvs_flags = XFLG_WORD_SPLIT | XFLG_NO_PREFIXES
++ | XFLG_DEF_EXCLUDE;
char fname[MAXPATHLEN];
char *p;
-+ add_exclude(&exclude_list, ". -p .cvsignore", 0);
- add_exclude(&exclude_list, default_cvsignore,
- XFLG_WORD_SPLIT | XFLG_WORDS_ONLY);
+- add_exclude(&exclude_list, default_cvsignore,
+- XFLG_WORD_SPLIT | XFLG_WORDS_ONLY);
++ add_exclude(&exclude_list, ":C", 0);
++ add_exclude(&exclude_list, default_cvsignore, cvs_flags);
---- orig/flist.c 2004-09-21 09:40:27
+ if ((p = getenv("HOME"))
+ && pathjoin(fname, sizeof fname, p, ".cvsignore") < sizeof fname) {
+- add_exclude_file(&exclude_list, fname,
+- XFLG_WORD_SPLIT | XFLG_WORDS_ONLY);
++ add_exclude_file(&exclude_list, fname, cvs_flags);
+ }
+
+- add_exclude(&exclude_list, getenv("CVSIGNORE"),
+- XFLG_WORD_SPLIT | XFLG_WORDS_ONLY);
++ add_exclude(&exclude_list, getenv("CVSIGNORE"), cvs_flags);
+ }
+--- orig/flist.c 2005-01-24 00:18:21
+++ flist.c 2004-08-12 18:59:28
-@@ -40,10 +40,9 @@ extern int module_id;
+@@ -40,11 +40,10 @@ extern int module_id;
extern int ignore_errors;
extern int numeric_ids;
-extern int cvs_exclude;
-
extern int recurse;
+ extern int xfer_dirs;
extern char curr_dir[MAXPATHLEN];
+extern unsigned int curr_dir_len;
- extern char *files_from;
extern int filesfrom_fd;
+ extern int one_file_system;
@@ -67,7 +66,6 @@ extern int list_only;
extern struct exclude_list_struct exclude_list;
return 1;
return 0;
}
-@@ -978,15 +971,7 @@ void send_file_name(int f, struct file_l
+@@ -983,15 +976,7 @@ void send_file_name(int f, struct file_l
if (recursive && S_ISDIR(file->mode)
&& !(file->flags & FLAG_MOUNT_POINT)) {
}
}
-@@ -997,6 +982,7 @@ static void send_directory(int f, struct
+@@ -1004,6 +989,7 @@ static void send_directory(int f, struct
struct dirent *di;
char fname[MAXPATHLEN];
unsigned int offset;
char *p;
d = opendir(dir);
-@@ -1020,18 +1006,7 @@ static void send_directory(int f, struct
+@@ -1027,18 +1013,7 @@ static void send_directory(int f, struct
offset++;
}
for (errno = 0, di = readdir(d); di; errno = 0, di = readdir(d)) {
char *dname = d_name(di);
-@@ -1052,6 +1027,8 @@ static void send_directory(int f, struct
+@@ -1060,6 +1035,8 @@ static void send_directory(int f, struct
rsyserr(FERROR, errno, "readdir(%s)", dir);
}
closedir(d);
}
-@@ -1071,6 +1048,7 @@ struct file_list *send_file_list(int f,
+@@ -1079,6 +1056,7 @@ struct file_list *send_file_list(int f,
char *p, *dir, olddir[sizeof curr_dir];
char lastpath[MAXPATHLEN] = "";
struct file_list *flist;
int64 start_write;
int use_ff_fd = 0;
-@@ -1091,6 +1069,10 @@ struct file_list *send_file_list(int f,
+@@ -1099,6 +1077,10 @@ struct file_list *send_file_list(int f,
exit_cleanup(RERR_FILESELECT);
}
use_ff_fd = 1;
}
}
-@@ -1121,6 +1103,15 @@ struct file_list *send_file_list(int f,
- }
- }
+@@ -1135,6 +1117,15 @@ struct file_list *send_file_list(int f,
+ } else if (recurse > 0)
+ recurse = 0;
+ if (need_first_push) {
+ if ((p = strrchr(fname, '/')) != NULL) {
if (link_stat(fname, &st, keep_dirlinks) != 0) {
if (f != -1) {
io_error |= IOERR_GENERAL;
---- orig/options.c 2004-10-14 17:11:40
-+++ options.c 2004-10-14 17:26:10
-@@ -287,6 +287,7 @@ void usage(enum logcode F)
+--- orig/loadparm.c 2005-01-01 21:11:00
++++ loadparm.c 2005-01-16 19:48:52
+@@ -133,6 +133,7 @@ typedef struct
+ char *auth_users;
+ char *secrets_file;
+ BOOL strict_modes;
++ char *filter;
+ char *exclude;
+ char *exclude_from;
+ char *include;
+@@ -175,6 +176,7 @@ static service sDefault =
+ NULL, /* auth users */
+ NULL, /* secrets file */
+ True, /* strict modes */
++ NULL, /* filter */
+ NULL, /* exclude */
+ NULL, /* exclude from */
+ NULL, /* include */
+@@ -294,6 +296,7 @@ static struct parm_struct parm_table[] =
+ {"auth users", P_STRING, P_LOCAL, &sDefault.auth_users, NULL, 0},
+ {"secrets file", P_STRING, P_LOCAL, &sDefault.secrets_file,NULL, 0},
+ {"strict modes", P_BOOL, P_LOCAL, &sDefault.strict_modes,NULL, 0},
++ {"filter", P_STRING, P_LOCAL, &sDefault.filter, NULL, 0},
+ {"exclude", P_STRING, P_LOCAL, &sDefault.exclude, NULL, 0},
+ {"exclude from", P_STRING, P_LOCAL, &sDefault.exclude_from,NULL, 0},
+ {"include", P_STRING, P_LOCAL, &sDefault.include, NULL, 0},
+@@ -378,6 +381,7 @@ FN_LOCAL_STRING(lp_hosts_deny, hosts_den
+ FN_LOCAL_STRING(lp_auth_users, auth_users)
+ FN_LOCAL_STRING(lp_secrets_file, secrets_file)
+ FN_LOCAL_BOOL(lp_strict_modes, strict_modes)
++FN_LOCAL_STRING(lp_filter, filter)
+ FN_LOCAL_STRING(lp_exclude, exclude)
+ FN_LOCAL_STRING(lp_exclude_from, exclude_from)
+ FN_LOCAL_STRING(lp_include, include)
+--- orig/options.c 2005-01-24 00:18:21
++++ options.c 2005-01-23 07:33:55
+@@ -146,6 +146,7 @@ int list_only = 0;
+ char *batch_name = NULL;
+
+ static int daemon_opt; /* sets am_daemon after option error-reporting */
++static int F_option_cnt = 0;
+ static int modify_window_set;
+ static char *dest_option = NULL;
+ static char *max_size_arg;
+@@ -294,6 +295,9 @@ void usage(enum logcode F)
+ rprintf(F," -P equivalent to --partial --progress\n");
+ rprintf(F," -z, --compress compress file data\n");
+ rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
++ rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
++ rprintf(F," -F same as --filter=': /.rsync-filter'\n");
++ rprintf(F," repeated: --filter='- .rsync-filter'\n");
+ rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
+ rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
- rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
- rprintf(F," --files-from=FILE read FILE for list of source-file names\n");
-+ rprintf(F," -E same as --exclude='. -p /.rsync-excludes'\n");
- rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
- rprintf(F," --version print version number\n");
- rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
-@@ -380,6 +381,7 @@ static struct poptOption long_options[]
+@@ -324,7 +328,7 @@ void usage(enum logcode F)
+ }
+
+ enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
+- OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
++ OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
+ OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
+ OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
+ OPT_REFUSED_BASE = 9000};
+@@ -346,6 +350,7 @@ static struct poptOption long_options[]
+ {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
+ {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
+ {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
++ {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
+ {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
+ {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
+ {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
+@@ -398,6 +403,7 @@ static struct poptOption long_options[]
{"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
{"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
{"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
-+ {0, 'E', POPT_ARG_NONE, 0, 'E', 0, 0 },
++ {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
{0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
+ {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
{"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
- {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
-@@ -652,6 +654,11 @@ int parse_arguments(int *argc, const cha
+@@ -619,10 +625,15 @@ int parse_arguments(int *argc, const cha
+ modify_window_set = 1;
+ break;
+
+- case OPT_EXCLUDE:
++ case OPT_FILTER:
+ add_exclude(&exclude_list, poptGetOptArg(pc), 0);
+ break;
+
++ case OPT_EXCLUDE:
++ add_exclude(&exclude_list, poptGetOptArg(pc),
++ XFLG_DEF_EXCLUDE);
++ break;
++
+ case OPT_INCLUDE:
+ add_exclude(&exclude_list, poptGetOptArg(pc),
+ XFLG_DEF_INCLUDE);
+@@ -640,8 +651,8 @@ int parse_arguments(int *argc, const cha
+ goto options_rejected;
+ }
+ add_exclude_file(&exclude_list, arg, XFLG_FATAL_ERRORS
+- | (opt == OPT_INCLUDE_FROM
+- ? XFLG_DEF_INCLUDE : 0));
++ | (opt == OPT_INCLUDE_FROM ? XFLG_DEF_INCLUDE
++ : XFLG_DEF_EXCLUDE));
+ break;
+
+ case 'h':
+@@ -665,6 +676,19 @@ int parse_arguments(int *argc, const cha
am_sender = 1;
break;
-+ case 'E':
-+ add_exclude(&exclude_list,
-+ ". -p /.rsync-excludes", 0);
++ case 'F':
++ switch (++F_option_cnt) {
++ case 1:
++ add_exclude(&exclude_list,
++ ": /.rsync-filter", 0);
++ break;
++ case 2:
++ add_exclude(&exclude_list,
++ "- .rsync-filter", 0);
++ break;
++ }
+ break;
+
case 'P':
do_progress = 1;
keep_partial = 1;
---- orig/rsync.h 2004-10-09 03:21:56
-+++ rsync.h 2004-09-22 08:48:53
-@@ -109,6 +109,7 @@
- #define XFLG_WORDS_ONLY (1<<2)
+@@ -971,7 +995,7 @@ int parse_arguments(int *argc, const cha
+ partial_dir = NULL;
+ else if (*partial_dir != '/') {
+ add_exclude(&exclude_list, partial_dir,
+- XFLG_DIRECTORY);
++ XFLG_DIRECTORY | XFLG_DEF_EXCLUDE);
+ }
+ keep_partial = 1;
+ }
+--- orig/rsync.h 2005-01-21 00:35:26
++++ rsync.h 2005-01-17 00:16:04
+@@ -109,9 +109,11 @@
+
+ #define XFLG_FATAL_ERRORS (1<<0)
+ #define XFLG_DEF_INCLUDE (1<<1)
+-#define XFLG_WORDS_ONLY (1<<2)
++#define XFLG_DEF_EXCLUDE (1<<2)
#define XFLG_WORD_SPLIT (1<<3)
#define XFLG_DIRECTORY (1<<4)
-+#define XFLG_ABS_PATH (1<<5)
++#define XFLG_NO_PREFIXES (1<<5)
++#define XFLG_ABS_PATH (1<<6)
#define PERMS_REPORT (1<<0)
#define PERMS_SKIP_MTIME (1<<1)
-@@ -503,11 +504,18 @@ struct map_struct {
+@@ -507,11 +509,21 @@ struct map_struct {
#define MATCHFLG_INCLUDE (1<<4) /* this is an include, not an exclude */
#define MATCHFLG_DIRECTORY (1<<5) /* this matches only directories */
#define MATCHFLG_CLEAR_LIST (1<<6) /* this item is the "!" token */
-+#define MATCHFLG_MERGE_FILE (1<<7) /* specifies a file to merge */
-+#define MATCHFLG_CVSIGNORE (1<<8) /* parse this as a .cvsignore file */
-+#define MATCHFLG_PERDIR_MERGE (1<<9) /* merge-file is searched per-dir */
-+#define MATCHFLG_FINISH_SETUP (1<<10)/* per-dir merge file needs setup */
++#define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
++#define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
++#define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
++#define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
++#define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
++#define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
++#define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
struct exclude_struct {
struct exclude_struct *next;
char *pattern;
};
struct exclude_list_struct {
---- orig/rsync.yo 2004-10-06 00:12:16
-+++ rsync.yo 2004-08-13 00:43:31
-@@ -364,6 +364,7 @@ verb(
+--- orig/rsync.yo 2005-01-24 00:18:21
++++ rsync.yo 2005-01-21 19:56:38
+@@ -362,6 +362,9 @@ verb(
+ -P equivalent to --partial --progress
+ -z, --compress compress file data
+ -C, --cvs-exclude auto ignore files in the same way CVS does
++ -f, --filter=RULE add a file-filtering RULE
++ -F same as --filter=': /.rsync-filter'
++ repeated: --filter='- .rsync-filter'
+ --exclude=PATTERN exclude files matching PATTERN
+ --exclude-from=FILE exclude patterns listed in FILE
--include=PATTERN don't exclude files matching PATTERN
- --include-from=FILE don't exclude patterns listed in FILE
- --files-from=FILE read FILE for list of source-file names
-+ -E same as --exclude='. -p /.rsync-excludes'
- -0 --from0 all file lists are delimited by nulls
- --version print version number
- --daemon run as an rsync daemon
-@@ -1037,24 +1038,32 @@ The exclude and include patterns specifi
- selection of which files to transfer and which files to skip.
-
- Rsync builds an ordered list of include/exclude options as specified on
+@@ -764,14 +767,41 @@ Finally, any file is ignored if it is in
+ .cvsignore file and matches one of the patterns listed therein.
+ See the bf(cvs(1)) manual for more information.
+
+-dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude
+-certain files from the list of files to be transferred. This is most
+-useful in combination with a recursive transfer.
++dit(bf(-f, --filter=RULE)) This option allows you to add rules to selectively
++exclude certain files from the list of files to be transferred. This is
++most useful in combination with a recursive transfer.
+
+-You may use as many --exclude options on the command line as you like
++You may use as many --filter options on the command line as you like
+ to build up the list of files to exclude.
+
+-See the EXCLUDE PATTERNS section for detailed information on this option.
++See the FILTER RULES section for detailed information on this option.
++
++dit(bf(-F)) The -F option is a shorthand for adding two --filter rules to
++your command. The first time it is used is a shorthand for this rule:
++
++verb(
++ --filter=': /.rsync-filter'
++)
++
++This tells rsync to look for per-directory .rsync-filter files that have
++been sprinkled through the hierarchy and use their rules to filter the
++files in the transfer. If -F is repeated, it is a shorthand for this
++rule:
++
++verb(
++ --filter='- .rsync-filter'
++)
++
++This filters out the .rsync-filter files themselves from the transfer.
++
++See the FILTER RULES section for detailed information on how these options
++work.
++
++dit(bf(--exclude=PATTERN)) This option is a simplified form of the
++--filter option that defaults to an exclude rule and does not allow
++the full rule-parsing syntax of normal filter rules.
++
++See the FILTER RULES section for detailed information on this option.
+
+ dit(bf(--exclude-from=FILE)) This option is similar to the --exclude
+ option, but instead it adds all exclude patterns listed in the file
+@@ -779,11 +809,11 @@ FILE to the exclude list. Blank lines i
+ ';' or '#' are ignored.
+ If em(FILE) is bf(-) the list will be read from standard input.
+
+-dit(bf(--include=PATTERN)) This option tells rsync to not exclude the
+-specified pattern of filenames. This is useful as it allows you to
+-build up quite complex exclude/include rules.
++dit(bf(--include=PATTERN)) This option is a simplified form of the
++--filter option that defaults to an include rule and does not allow
++the full rule-parsing syntax of normal filter rules.
+
+-See the EXCLUDE PATTERNS section for detailed information on this option.
++See the FILTER RULES section for detailed information on this option.
+
+ dit(bf(--include-from=FILE)) This specifies a list of include patterns
+ from a file.
+@@ -828,7 +858,8 @@ was located on the remote "src" host.
+
+ dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a
+ file are terminated by a null ('\0') character, not a NL, CR, or CR+LF.
+-This affects --exclude-from, --include-from, and --files-from.
++This affects --exclude-from, --include-from, --files-from, and any
++merged files specified in a --filter rule.
+ It does not affect --cvs-exclude (since all names read from a .cvsignore
+ file are split on whitespace).
+
+@@ -967,8 +998,8 @@ If the partial-dir value is not an absol
+ will prevent partial-dir files from being transferred and also prevent the
+ untimely deletion of partial-dir items on the receiving side. An example:
+ the above --partial-dir option would add an "--exclude=.rsync-partial/"
+-rule at the end of any other include/exclude rules. Note that if you are
+-supplying your own include/exclude rules, you may need to manually insert a
++rule at the end of any other filter rules. Note that if you are
++supplying your own filter rules, you may need to manually insert a
+ rule for this directory exclusion somewhere higher up in the list so that
+ it has a high enough priority to be effective (e.g., if your rules specify
+ a trailing --exclude=* rule, the auto-added rule will be ineffective).
+@@ -1125,30 +1156,322 @@ page describing the options available fo
+
+ enddit()
+
+-manpagesection(EXCLUDE PATTERNS)
+-
+-The exclude and include patterns specified to rsync allow for flexible
+-selection of which files to transfer and which files to skip.
++manpagesection(FILTER RULES)
+
+-Rsync builds an ordered list of include/exclude options as specified on
-the command line. Rsync checks each file and directory
-name against each exclude/include pattern in turn. The first matching
-+the command line.
-+It can also be told to check for include/exclude options in each
-+directory that rsync visits during the transfer (see the section on
-+MERGED EXCLUDE FILES for the details on these per-directory exclude
-+files).
+-pattern is acted on. If it is an exclude pattern, then that file is
+-skipped. If it is an include pattern then that filename is not
+-skipped. If no matching include/exclude pattern is found then the
++The filter rules allow for flexible selection of which files to transfer
++(include) and which files to skip (exclude). The rules either directly
++specify include/exclude patterns or they specify a way to acquire more
++include/exclude patterns (e.g. to read them from a file).
+
+As the list of files/directories to transfer is built, rsync checks each
-+name against every exclude/include pattern in turn. The first matching
- pattern is acted on. If it is an exclude pattern, then that file is
- skipped. If it is an include pattern then that filename is not
- skipped. If no matching include/exclude pattern is found then the
++name to be transferred against the list of include/exclude patterns in
++turn, and the first matching pattern is acted on: if it is an exclude
++pattern, then that file is skipped; if it is an include pattern then that
++filename is not skipped; if no matching pattern is found, then the
filename is not skipped.
-The filenames matched against the exclude/include patterns are relative
-subtree of names that are being sent from sender to receiver, the root
-is where the tree starts to be duplicated in the destination directory.
-This root governs where patterns that start with a / match (see below).
-+The global include/exclude rules are anchored at the "root of the
-+transfer" (as opposed to per-directory rules, which are anchored at
-+the merge-file's directory). If you think of the transfer as a
-+subtree of names that are being sent from sender to receiver, the
-+transfer-root is where the tree starts to be duplicated in the
-+destination directory. This root governs where patterns that start
-+with a / match (as described in the list on pattern forms below).
-
- Because the matching is relative to the transfer-root, changing the
- trailing slash on a source path or changing your use of the --relative
- option affects the path you need to use in your matching (in addition to
- changing how much of the file tree is duplicated on the destination
--system). The following examples demonstrate this.
-+host). The following examples demonstrate this.
-
- Let's say that we want to match two source files, one with an absolute
- path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
-@@ -1101,23 +1110,27 @@ because rsync did not descend through th
- hierarchy.
-
- Note also that the --include and --exclude options take one pattern
--each. To add multiple patterns use the --include-from and
----exclude-from options or multiple --include and --exclude options.
-+each. To add multiple patterns use the --include-from and --exclude-from
-+options or multiple --include and --exclude options.
-
--The patterns can take several forms. The rules are:
-+The include/exclude patterns can take several forms. The rules are:
-
- itemize(
-
-- it() if the pattern starts with a / then it is matched against the
-- start of the filename, otherwise it is matched against the end of
-- the filename.
-- This is the equivalent of a leading ^ in regular expressions.
-- Thus "/foo" would match a file called "foo" at the transfer-root
-- (see above for how this is different from the filesystem-root).
-- On the other hand, "foo" would match any file called "foo"
++Rsync builds an ordered list of filter rules as specified on the
++command-line. Filter rules have the following syntax:
++
++itemize(
++ it() x RULE
++ it() xMODIFIERS RULE
++ it() !
++)
++
++The 'x' is a single-letter that specifies the kind of rule to create. It
++can have trailing modifiers, and is separated from the RULE by one of the
++following characters: a single space, an equal-sign (=), or an underscore
++(_). Here are the available rule prefixes:
++
++verb(
++ - specifies an exclude pattern.
++ + specifies an include pattern.
++ . specifies a merge-file to read for more rules.
++ : specifies a per-directory merge-file.
++ ! clears the current include/exclude list
++)
++
++Note that the --include/--exclude command-line options do not allow the
++full range of rule parsing as described above -- they only allow the
++specification of include/exclude patterns and the "!" token (not to
++mention the comment lines when reading rules from a file). If a pattern
++does not begin with "- " (dash, space) or "+ " (plus, space), then the
++rule will be interpreted as if "+ " (for an include option) or "- " (for
++an exclude option) were prefixed to the string. A --filter option, on
++the other hand, must always contain one of the prefixes above.
++
++Note also that the --filter, --include, and --exclude options take one
++rule/pattern each. To add multiple ones, you can repeat the options on
++the command-line, use the merge-file syntax of the --filter option, or
++the --include-from/--exclude-from options.
++
++When rules are being read from a file, empty lines are ignored, as are
++comment lines that start with a "#".
++
++manpagesection(INCLUDE/EXCLUDE PATTERN RULES)
++
++You can include and exclude files by specifing patterns using the "+" and
++"-" filter rules (as introduced in the FILTER RULES section above). These
++rules specify a pattern that is matched against the names of the files
++that are going to be transferred. These patterns can take several forms:
++
++itemize(
++
+ it() if the pattern starts with a / then it is anchored to a
+ particular spot in the hierarchy of files, otherwise it is matched
+ against the end of the pathname. This is similar to a leading ^ in
+ transfer" (for a global rule) or in the merge-file's directory (for a
+ per-directory rule).
+ An unqualified "foo" would match any file or directory named "foo"
- anywhere in the tree because the algorithm is applied recursively from
++ anywhere in the tree because the algorithm is applied recursively from
+ the
- top down; it behaves as if each path component gets a turn at being the
-- end of the file name.
++ top down; it behaves as if each path component gets a turn at being the
+ end of the file name. Even the unanchored "sub/foo" would match at
+ any point in the hierarchy where a "foo" was found within a directory
-+ named "sub".
-
- it() if the pattern ends with a / then it will only match a
- directory, not a file, link, or device.
-@@ -1130,22 +1143,31 @@ itemize(
- single asterisk pattern "*" will stop at slashes.
-
- it() if the pattern contains a / (not counting a trailing /) or a "**"
-- then it is matched against the full filename, including any leading
-- directory. If the pattern doesn't contain a / or a "**", then it is
++ named "sub". See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for
++ a full discussion of how to specify a pattern that matches at the root
++ of the transfer.
++
++ it() if the pattern ends with a / then it will only match a
++ directory, not a file, link, or device.
++
++ it() if the pattern contains a wildcard character from the set
++ *?[ then expression matching is applied using the shell filename
++ matching rules. Otherwise a simple string match is used.
++
++ it() the double asterisk pattern "**" will match slashes while a
++ single asterisk pattern "*" will stop at slashes.
++
++ it() if the pattern contains a / (not counting a trailing /) or a "**"
+ then it is matched against the full pathname, including any leading
+ directories. If the pattern doesn't contain a / or a "**", then it is
- matched only against the final component of the filename. Again,
- remember that the algorithm is applied recursively so "full filename" can
- actually be any portion of a path below the starting directory.
-
- it() if the pattern starts with "+ " (a plus followed by a space)
- then it is always considered an include pattern, even if specified as
-- part of an exclude option. The prefix is discarded before matching.
-+ part of an exclude option. (The prefix is discarded before matching.)
-
- it() if the pattern starts with "- " (a minus followed by a space)
- then it is always considered an exclude pattern, even if specified as
-- part of an include option. The prefix is discarded before matching.
-+ part of an include option. (The prefix is discarded before matching.)
-+
-+ it() if the pattern starts with ". " (a dot followed by a space) then its
-+ pattern is taken to be a merge-file that is read in to supplement the
-+ current rules. See the section on MERGED EXCLUDE FILES for more
-+ information.
-
- it() if the pattern is a single exclamation mark ! then the current
- include/exclude list is reset, removing all previously defined patterns.
-+ The "current" list is either the global list of rules (which are
-+ specified via options) or a set of per-directory rules (which are
-+ inherited in their own sub-list, so a subdirectory can use this to
-+ clear out the parent's rules).
- )
-
- The +/- rules are most useful in a list that was read from a file, allowing
-@@ -1192,8 +1214,160 @@ itemize(
- it() --include "*/" --include "*.c" --exclude "*" would include all
- directories and C source files
- it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
-- only foo/bar.c (the foo/ directory must be explicitly included or
-- it would be excluded by the "*")
++ matched only against the final component of the filename.
++ (Remember that the algorithm is applied recursively so "full filename"
++ can actually be any portion of a path fomr the starting directory on
++ down.)
++
++)
++
++Note that, when using the --recursive (-r) option (which is implied by
++-a), every subcomponent of every path is visited from the top down, so
++include/exclude patterns get applied recursively to each subcomponent's
++full name (e.g. to include "/foo/bar/baz" the subcomponents "/foo" and
++"/foo/bar" must not be excluded).
++The exclude patterns actually short-circuit the directory traversal stage
++when rsync finds the files to send. If a pattern excludes a particular
++parent directory, it can render a deeper include pattern ineffectual
++because rsync did not descend through that excluded section of the
++hierarchy. This is particularly important when using a trailing '*' rule.
++For instance, this won't work:
++
++verb(
++ + /some/path/this-file-will-not-be-found
++ + /file-is-included
++ - *
++)
++
++This fails because the parent directory "some" is excluded by the '*'
++rule, so rsync never visits any of the files in the "some" or "some/path"
++directories. One solution is to ask for all directories in the hierarchy
++to be included by using a single rule: "+_*/" (put it somewhere before the
++"-_*" rule). Another solution is to add specific include rules for all
++the parent dirs that need to be visited. For instance, this set of rules
++works fine:
++
++verb(
++ + /some/
++ + /some/path/
++ + /some/path/this-file-is-found
++ + /file-also-included
++ - *
++)
++
++Here are some examples of exclude/include matching:
++
++itemize(
++ it() "- *.o" would exclude all filenames matching *.o
++ it() "- /foo" would exclude a file called foo in the transfer-root directory
++ it() "- foo/" would exclude any directory called foo
++ it() "- /foo/*/bar" would exclude any file called bar two
++ levels below a directory called foo in the transfer-root directory
++ it() "- /foo/**/bar" would exclude any file called bar two
++ or more levels below a directory called foo in the transfer-root directory
++ it() The combination of "+ */", "+ *.c", and "- *" would include all
++ directories and C source files but nothing else.
++ it() The combination of "+ foo/", "+ foo/bar.c", and "- *" would include
+ only the foo directory and foo/bar.c (the foo directory must be
+ explicitly included or it would be excluded by the "*")
+)
+
-+manpagesection(MERGED EXCLUDE FILES)
++manpagesection(MERGE-FILE FILTER RULES)
+
-+You can merge whole files into an exclude file by specifying a rule that
-+starts with a ". " (a dot followed by a space) and putting a filename in
-+place of the pattern. There are two kinds of merged exclude files --
-+single-instance and per-directory. The choice is made via an option
-+placed prior to the merge-file name:
++You can merge whole files into your filter rules by specifying either a
++"." or a ":" filter rule (as introduced in the FILTER RULES section
++above).
+
-+startdit()
++There are two kinds of merged files -- single-instance ('.') and
++per-directory (':'). A single-instance merge file is read one time, and
++its rules are incorporated into the filter list in the place of the "."
++rule. For per-directory merge files, rsync will scan every directory that
++it traverses for the named file, merging its contents when the file exists
++into the current list of inherited rules. These per-directory rule files
++must be created on the sending side because it is the sending side that is
++being scanned for the available files to transfer. These rule files may
++also need to be transferred to the receiving side if you want them to
++affect what files don't get deleted (see PER-DIRECTORY RULES AND DELETE
++below).
+
-+dit(bf(-p)) Make the file a per-directory merge-file. Rsync will scan
-+every directory that it traverses for the named file, merging its contents
-+when the file exists. These exclude files must exist on the sending side
-+because it is the sending side that is being scanned for available files
-+to send. The files may also need to be transferred to the receiving side
-+if you want them to affect what files don't get deleted (see PER-DIRECTORY
-+EXCLUDES AND DELETE below).
++Some examples:
+
-+dit(bf(--)) End the scanning of options. Useful if you want to specify a
-+filename that begins with a dash.
++verb(
++ . /etc/rsync/default.rules
++ : .per-dir-filter
++ :n- .non-inherited-per-dir-excludes
++)
+
-+enddit()
++The following modifiers are accepted after the "." or ":":
+
-+Per-directory rules are inherited in all subdirectories of the directory
-+where the merge-file was found. Each subdirectory's rules are prefixed
-+to the inherited rules from the parent directories, which gives the
-+newest rules a higher priority than the inherited rules. The entire set
-+of per-dir rules is grouped together in the spot where the merge-file was
-+specified, so it is possible to override per-dir rules via a rule that
-+got specified earlier in the list of global rules.
++itemize(
++ it() A "-" specifies that the file should consist of only exclude
++ patterns, with no other rule-parsing except for the list-clearing
++ token ("!").
++
++ it() A "+" specifies that the file should consist of only include
++ patterns, with no other rule-parsing except for the list-clearing
++ token ("!").
++
++ it() A "C" is a shorthand for the modifiers "sn-", which makes the
++ parsing compatible with the way CVS parses their exclude files. If no
++ filename is specified, ".cvsignore" is assumed.
++
++ it() A "e" will exclude the merge-file from the transfer; e.g.
++ ":e_.rules" is like ":_.rules" and "-_.rules".
++
++ it() An "n" specifies that the rules are not inherited by subdirectories.
+
-+If you don't want a per-dir rule to be inherited, anchor it with a leading
-+slash. Anchored rules in a per-directory merge-file are relative to the
-+merge-file's directory, so a rule "/foo" would only exclude the file "foo"
-+in the directory where the per-dir exclude file was found.
++ it() An "s" specifies that the rules are split on all whitespace instead
++ of the normal line-splitting. This also turns off comments. Note: the
++ space that separates the prefix from the rule is treated specially, so
++ "- foo + bar" is parsed as two rules (assuming that "-" or "+" was not
++ specified to turn off the parsing of prefixes).
++)
+
-+Here's an example exclude file which you'd specify via the normal
-+--exclude-from=FILE option:
++Per-directory rules are inherited in all subdirectories of the directory
++where the merge-file was found unless the 'n' modifier was used. Each
++subdirectory's rules are prefixed to the inherited per-directory rules
++from its parents, which gives the newest rules a higher priority than the
++inherited rules. The entire set of per-dir rules is grouped together in
++the spot where the merge-file was specified, so it is possible to override
++per-dir rules via a rule that got specified earlier in the list of global
++rules. When the list-clearing rule ("!") is read from a per-directory
++file, it only clears the inherited rules for the current merge file.
++
++Another way to prevent a single per-dir rule from being inherited is to
++anchor it with a leading slash. Anchored rules in a per-directory
++merge-file are relative to the merge-file's directory, so a pattern "/foo"
++would only match the file "foo" in the directory where the per-dir filter
++file was found.
++
++Here's an example filter file which you'd specify via --filter=". file":
+
+verb(
-+ . /home/user/.global_excludes
-+ *.gz
-+ . -p .excl
++ . /home/user/.global-filter
++ - *.gz
++ : .rules
+ + *.[ch]
-+ *.o
++ - *.o
+)
+
-+This will merge the contents of the /home/user/.global_excludes file at the
-+start of the list and also turns the ".excl" filename into a per-directory
-+exclude file. All the merged rules default to being exclude rules because
-+an exclude statement was used to specify them. Rules read in from the
-+.global_excludes file are anchored just like all other global rules.
++This will merge the contents of the /home/user/.global-filter file at the
++start of the list and also turns the ".rules" filename into a per-directory
++filter file. All rules read-in prior to the start of the directory scan
++follow the global anchoring rules (i.e. a leading slash matches at the root
++of the transfer).
+
+If a per-directory merge-file is specified with a path that is a parent
+directory of the first transfer directory, rsync will scan all the parent
+dirs from that starting point to the transfer directory for the indicated
-+per-directory file. For instance, the -E option is an abbreviation for
-+this command:
++per-directory file. For instance, here is a common filter (see -F):
+
+verb(
-+ --exclude='. -p /.rsync-excludes'
++ --filter=': /.rsync-filter'
+)
+
-+That exclude tells rsync to scan for the file .rsync-excludes in all
-+directories from the root down through the source of the transfer. (For
-+an rsync daemon, the "root dir" is always the module's "path" setting.)
++That rule tells rsync to scan for the file .rsync-filter in all
++directories from the root down through the parent directory of the
++transfer prior to the start of the normal directory scan of the file in
++the directories that are sent as a part of the transfer. (Note: for an
++rsync daemon, the root is always the same as the module's "path".)
+
+Some examples of this pre-scanning for per-directory files:
+
+verb(
-+ rsync -avE /src/path/ /dest/dir
-+ rsync -av --exclude='. -p ../../.rsync-excludes' /src/path/ /dest/dir
-+ rsync -av --exclude='. -p .rsync-excludes' /src/path/ /dest/dir
++ rsync -avF /src/path/ /dest/dir
++ rsync -av --filter=': ../../.rsync-filter' /src/path/ /dest/dir
++ rsync -av --fitler=': .rsync-filter' /src/path/ /dest/dir
+)
+
-+The first two commands above will look for ".rsync-excludes" in "/" and
++The first two commands above will look for ".rsync-filter" in "/" and
+"/src" before the normal scan begins looking for the file in "/src/path"
+and its subdirectories. The last command avoids the parent-dir scan
-+and only looks for the ".rsync-excludes" files in each directory that is
++and only looks for the ".rsync-filter" files in each directory that is
+a part of the transfer.
+
-+Finally, note that the parsing of any merge-file named ".cvsignore" is
-+always done in a CVS-compatible manner, even if -C wasn't specified. This
-+means that its rules are always excludes (even if an include option
-+specified the file), patterns are split on whitespace, the rules are never
-+inherited, and no special characters are honored (e.g. no comments, no "!",
-+etc.).
-+
-+Additionally, you can affect where the --cvs-exclude (-C) option's
-+inclusion of the per-directory .cvsignore file gets placed into your rules
-+by adding your own explicit per-directory merge rule for ".cvsignore".
-+Without this, rsync would add its this rule at the end of all your other
++If you want to include the contents of a ".cvsignore" in your patterns,
++you should use the rule ":C" -- this is a short-hand for the rule
++":sn-_.cvsignore", and ensures that the .cvsignore file's contents are
++interpreted according to the same parsing rules that CVS uses. You can
++use this to affect where the --cvs-exclude (-C) option's inclusion of the
++per-directory .cvsignore file gets placed into your rules by putting a
++":C" wherever you like in your filter rules. Without this, rsync would
++add the per-dir rule for the .cvignore file at the end of all your other
+rules (giving it a lower priority than your command-line rules). For
+example:
+
+verb(
-+ rsync -avC --exclude='. -p .cvsignore' --exclude-from=foo a/ b
++ cat <<EOT | rsync -avC --filter='. -' a/ b
++ + foo.o
++ :C
++ - *.old
++ EOT
++
++ rsync -avC --include=foo.o -f :C --exclude='*.old' a/ b
+)
+
-+The above will merge all the per-directory .cvsignore rules at the start of
-+your list rather than at the end. This allows their dir-specific rules to
-+supersede your rules instead of being subservient to them. (The global
-+rules taken from the $HOME/.cvsignore file and from $CVSIGNORE are not
-+repositioned by this.)
++Both of the above rsync commands are identical. Each one will merge all
++the per-directory .cvsignore rules in the middle of the list rather than
++at the end. This allows their dir-specific rules to supersede the rules
++that follow the :C instead of being subservient to all your rules. (The
++global rules taken from the $HOME/.cvsignore file and from $CVSIGNORE are
++not repositioned from their spot at the end of your rules, however -- feel
++free to manually include $HOME/.cvsignore elsewhere in your rules.)
+
-+manpagesection(PER-DIRECTORY EXCLUDES AND DELETE)
++manpagesection(LIST-CLEARING FILTER RULE)
+
-+Without a delete option, per-directory excludes are only relevant on the
-+sending side, so you can feel free to exclude the merge files themselves
-+without affecting the transfer:
++You can clear the current include/exclude list by using the "!" filter
++rule (as introduced in the FILTER RULES section above). The "current"
++list is either the global list of rules (if the rule is encountered while
++parsing the filter options) or a set of per-directory rules (which are
++inherited in their own sub-list, so a subdirectory can use this to clear
++out the parent's rules).
+
++manpagesection(ANCHORING INCLUDE/EXCLUDE PATTERNS)
++
++As mentioned earlier, global include/exclude patterns are anchored at the
++"root of the transfer" (as opposed to per-directory patterns, which are
++anchored at the merge-file's directory). If you think of the transfer as
++a subtree of names that are being sent from sender to receiver, the
++transfer-root is where the tree starts to be duplicated in the destination
++directory. This root governs where patterns that start with a / match.
+
+ Because the matching is relative to the transfer-root, changing the
+ trailing slash on a source path or changing your use of the --relative
+ option affects the path you need to use in your matching (in addition to
+ changing how much of the file tree is duplicated on the destination
+-system). The following examples demonstrate this.
++host). The following examples demonstrate this.
+
+ Let's say that we want to match two source files, one with an absolute
+ path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
+@@ -1180,115 +1503,59 @@ verb(
+ Target file: /dest/you/bar/baz
+ )
+
+-The easiest way to see what name you should include/exclude is to just
++The easiest way to see what name you should filter is to just
+ look at the output when using --verbose and put a / in front of the name
+ (use the --dry-run option if you're not yet ready to copy any files).
+
+-Note that, when using the --recursive (-r) option (which is implied by -a),
+-every subcomponent of
+-every path is visited from the top down, so include/exclude patterns get
+-applied recursively to each subcomponent's full name (e.g. to include
+-"/foo/bar/baz" the subcomponents "/foo" and "/foo/bar" must not be excluded).
+-The exclude patterns actually short-circuit the directory traversal stage
+-when rsync finds the files to send. If a pattern excludes a particular
+-parent directory, it can render a deeper include pattern ineffectual
+-because rsync did not descend through that excluded section of the
+-hierarchy.
+-
+-Note also that the --include and --exclude options take one pattern
+-each. To add multiple patterns use the --include-from and
+---exclude-from options or multiple --include and --exclude options.
++manpagesection(PER-DIRECTORY RULES AND DELETE)
+
+-The patterns can take several forms. The rules are:
++Without a delete option, per-directory rules are only relevant on the
++sending side, so you can feel free to exclude the merge files themselves
++without affecting the transfer. To make this easy, the 'e' modifier adds
++this exclude for you, as seen in these two equivalent commands:
+
+-itemize(
+-
+- it() if the pattern starts with a / then it is matched against the
+- start of the filename, otherwise it is matched against the end of
+- the filename.
+- This is the equivalent of a leading ^ in regular expressions.
+- Thus "/foo" would match a file called "foo" at the transfer-root
+- (see above for how this is different from the filesystem-root).
+- On the other hand, "foo" would match any file called "foo"
+- anywhere in the tree because the algorithm is applied recursively from
+- top down; it behaves as if each path component gets a turn at being the
+- end of the file name.
+-
+- it() if the pattern ends with a / then it will only match a
+- directory, not a file, link, or device.
+-
+- it() if the pattern contains a wildcard character from the set
+- *?[ then expression matching is applied using the shell filename
+- matching rules. Otherwise a simple string match is used.
+-
+- it() the double asterisk pattern "**" will match slashes while a
+- single asterisk pattern "*" will stop at slashes.
+verb(
-+ rsync -av --exclude='. -p .excl' --exclude=.excl host:src/dir /dest
++ rsync -av --filter=': .excl' --exclude=.excl host:src/dir /dest
++ rsync -av --filter=':e .excl' host:src/dir /dest
+)
-+
+
+- it() if the pattern contains a / (not counting a trailing /) or a "**"
+- then it is matched against the full filename, including any leading
+- directory. If the pattern doesn't contain a / or a "**", then it is
+- matched only against the final component of the filename. Again,
+- remember that the algorithm is applied recursively so "full filename" can
+- actually be any portion of a path below the starting directory.
+-
+- it() if the pattern starts with "+ " (a plus followed by a space)
+- then it is always considered an include pattern, even if specified as
+- part of an exclude option. The prefix is discarded before matching.
+-
+- it() if the pattern starts with "- " (a minus followed by a space)
+- then it is always considered an exclude pattern, even if specified as
+- part of an include option. The prefix is discarded before matching.
+-
+- it() if the pattern is a single exclamation mark ! then the current
+- include/exclude list is reset, removing all previously defined patterns.
+-)
+-
+-The +/- rules are most useful in a list that was read from a file, allowing
+-you to have a single exclude list that contains both include and exclude
+-options in the proper order.
+-
+-Remember that the matching occurs at every step in the traversal of the
+-directory hierarchy, so you must be sure that all the parent directories of
+-the files you want to include are not excluded. This is particularly
+-important when using a trailing '*' rule. For instance, this won't work:
+However, if you want to do a delete on the receiving side AND you want some
+files to be excluded from being deleted, you'll need to be sure that the
+receiving side knows what files to exclude. The easiest way is to include
-+the per-directory merge files in the transfer and use --delete-after
++the per-directory merge files in the transfer and use --delete-after,
+because this ensures that the receiving side gets all the same exclude
+rules as the sending side before it tries to delete anything:
-+
-+verb(
-+ rsync -avE --delete-after host:src/dir /dest
-+)
-+
-+However, if you the merge files are not a part of the transfer, you'll need
-+to either use a global exclude rule (i.e. specified on the command line),
-+or you'll need to maintain your own per-directory merge files on the
-+receiving side. An example of the first is this (assume that the remote
-+.ctrl files exclude themselves):
-+
-+verb(
-+ rsync -av --exclude='. -p .ctrl' --exclude-from=/my/extra.rules
+
+ verb(
+- + /some/path/this-file-will-not-be-found
+- + /file-is-included
+- - *
++ rsync -avF --delete-after host:src/dir /dest
+ )
+
+-This fails because the parent directory "some" is excluded by the '*' rule,
+-so rsync never visits any of the files in the "some" or "some/path"
+-directories. One solution is to ask for all directories in the hierarchy
+-to be included by using a single rule: --include='*/' (put it somewhere
+-before the --exclude='*' rule). Another solution is to add specific
+-include rules for all the parent dirs that need to be visited. For
+-instance, this set of rules works fine:
++However, if the merge files are not a part of the transfer, you'll need to
++either specify some global exclude rules (i.e. specified on the command
++line), or you'll need to maintain your own per-directory merge files on
++the receiving side. An example of the first is this (assume that the
++remote .rules files exclude themselves):
+
+ verb(
+- + /some/
+- + /some/path/
+- + /some/path/this-file-is-found
+- + /file-also-included
+- - *
++ rsync -av --filter=': .rules' --filter='. /my/extra.rules'
+ --delete host:src/dir /dest
-+)
-+
+ )
+
+-Here are some examples of exclude/include matching:
+In the above example the extra.rules file can affect both sides of the
-+transfer, but the rules are subservient to the rules merged from the .ctrl
-+files because they were specified after the per-directory merge rule.
++transfer, but (on the sending side) the rules are subservient to the rules
++merged from the .rules files because they were specified after the
++per-directory merge rule.
+
-+In the final example, the remote side is excluding the .rsync-excludes
-+files from the transfer, but we want to use our own .rsync-excludes files
++In one final example, the remote side is excluding the .rsync-filter
++files from the transfer, but we want to use our own .rsync-filter files
+to control what gets deleted on the receiving side. To do this we must
+specifically exclude the per-directory merge files (so that they don't get
+deleted) and then put rules into the local files to control what else
-+should not get deleted. Like this:
-+
++should not get deleted. Like one of these commands:
+
+-itemize(
+- it() --exclude "*.o" would exclude all filenames matching *.o
+- it() --exclude "/foo" would exclude a file called foo in the transfer-root directory
+- it() --exclude "foo/" would exclude any directory called foo
+- it() --exclude "/foo/*/bar" would exclude any file called bar two
+- levels below a directory called foo in the transfer-root directory
+- it() --exclude "/foo/**/bar" would exclude any file called bar two
+- or more levels below a directory called foo in the transfer-root directory
+- it() --include "*/" --include "*.c" --exclude "*" would include all
+- directories and C source files
+- it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
+- only foo/bar.c (the foo/ directory must be explicitly included or
+- it would be excluded by the "*")
+verb(
-+ rsync -avE --exclude=.rsync-excludes --delete host:src/dir /dest
++ rsync -av --filter=':e /.rsync-filter' --delete host:src/dir /dest
++ rsync -avFF --delete host:src/dir /dest
)
manpagesection(BATCH MODE)
+@@ -1457,7 +1724,7 @@ it. The most common cause is incorrectly
+ scripts (such as .cshrc or .profile) that contain output statements
+ for non-interactive logins.
+
+-If you are having trouble debugging include and exclude patterns, then
++If you are having trouble debugging filter patterns, then
+ try specifying the -vv option. At this level of verbosity rsync will
+ show why each individual file is included or excluded.
+
+--- orig/rsyncd.conf.yo 2005-01-01 21:11:01
++++ rsyncd.conf.yo 2005-01-17 06:49:39
+@@ -208,6 +208,16 @@ file transfers to and from that module s
+ was run as root. This complements the "uid" option. The default is gid -2,
+ which is normally the group "nobody".
+
++dit(bf(filter)) The "filter" option allows you to specify a space-separated
++list of filter rules that the server will not allow to be read or written.
++This is only superficially equivalent to the client specifying these
++patterns with the --filter option. Only one "filter" option may be
++specified, but it may contain as many rules as you like, including
++merge-file rules. Note that per-directory merge-file rules do not provide
++as much protection as global rules, but they can be used to make --delete
++work better when a client downloads the server's files (if the per-dir
++merge files are included in the transfer).
++
+ dit(bf(exclude)) The "exclude" option allows you to specify a
+ space-separated list of patterns that the server will not allow to be read
+ or written. This is only superficially equivalent to the client
--- orig/testsuite/exclude.test 2004-05-29 21:25:45
-+++ testsuite/exclude.test 2004-08-08 06:35:15
-@@ -23,19 +23,47 @@ export HOME CVSIGNORE
++++ testsuite/exclude.test 2005-01-17 06:19:10
+@@ -23,19 +23,50 @@ export HOME CVSIGNORE
makepath "$fromdir/foo/down/to/you"
makepath "$fromdir/bar/down/to/foo/too"
makepath "$fromdir/mid/for/foo/and/that/is/who"
+cat >"$fromdir/.excl" <<EOF
-+.excl
-+*.bak
-+*.old
-+*.junk
++- down
++: .excl-temp
++!
++- .excl
++- *.bak
++- *.old
++- *.junk
+EOF
echo kept >"$fromdir/foo/file1"
echo removed >"$fromdir/foo/file2"
+- file1
+EOF
+cat >"$fromdir/bar/.excl" <<EOF
-+home-cvs-exclude
-+. -p .excl2
++- home-cvs-exclude
++: .excl2
++ to
+EOF
echo cvsout >"$fromdir/bar/down/to/home-cvs-exclude"
+cat >"$fromdir/bar/down/to/.excl2" <<EOF
-+.excl2
++- .excl2
+EOF
echo keeper >"$fromdir/bar/down/to/foo/file1"
echo cvsout >"$fromdir/bar/down/to/foo/file1.bak"
+EOF
+# This one should be ineffectual
+cat >"$fromdir/mid/.excl2" <<EOF
-+extra
++- extra
+EOF
echo cvsout >"$fromdir/mid/one-in-one-out"
echo one-in-one-out >"$fromdir/mid/.cvsignore"
echo cvsin >"$fromdir/mid/one-for-all"
+cat >"$fromdir/mid/.excl" <<EOF
-+. -p .cvsignore
++:C
+EOF
echo cvsin >"$fromdir/mid/for/one-in-one-out"
echo expunged >"$fromdir/mid/for/foo/extra"
echo retained >"$fromdir/mid/for/foo/keep"
-@@ -100,5 +128,24 @@ $RSYNC -av --existing --include='*/' --e
- checkit "$RSYNC -avvC --exclude-from=\"$excl\" \
- --delete-excluded \"$fromdir/\" \"$todir/\"" "$chkdir" "$todir"
+@@ -45,6 +76,7 @@ ln -s too "$fromdir/bar/down/to/foo/sym"
+
+ excl="$scratchdir/exclude-from"
+ cat >"$excl" <<EOF
++!
+ # If the second line of these two lines does anything, it's a bug.
+ + **/bar
+ - /bar
+@@ -82,7 +114,8 @@ $RSYNC -av --existing --include='*/' --e
+
+ # Now, test if rsync excludes the same files.
+
+-checkit "$RSYNC -avv --exclude-from=\"$excl\" \"$fromdir/\" \"$todir/\"" "$chkdir" "$todir"
++checkit "$RSYNC -avv --exclude-from=\"$excl\" \
++ --delete \"$fromdir/\" \"$todir/\"" "$chkdir" "$todir"
+
+ # Modify the chk dir by removing cvs-ignored files and then tweaking the dir times.
+@@ -97,7 +130,26 @@ $RSYNC -av --existing --include='*/' --e
+ # Now, test if rsync excludes the same files, this time with --cvs-exclude
+ # and --delete-excluded.
+
+-checkit "$RSYNC -avvC --exclude-from=\"$excl\" \
++checkit "$RSYNC -avvC --filter=\". $excl\" \
++ --delete-excluded \"$fromdir/\" \"$todir/\"" "$chkdir" "$todir"
++
+# Modify the chk dir for our merge-exclude test and then tweak the dir times.
+
+rm "$chkdir"/.excl
+# Now, test if rsync excludes the same files, this time with a merge-exclude
+# file.
+
-+checkit "$RSYNC -avv --exclude='. -p .excl' --exclude-from=\"$excl\" \
-+ --delete-excluded \"$fromdir/\" \"$todir/\"" "$chkdir" "$todir"
-+
++checkit "sed '/!/d' \"$excl\" | $RSYNC -avv -f :_.excl -f ._- \
+ --delete-excluded \"$fromdir/\" \"$todir/\"" "$chkdir" "$todir"
+
# The script would have aborted on error, so getting here means we've won.
- exit 0