Skip to content

Commit

Permalink
Follow gem naming conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
tadast committed Mar 7, 2013
1 parent 98022e0 commit a841524
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
20 changes: 10 additions & 10 deletions README.rdoc
@@ -1,35 +1,35 @@
== Synopsis

Executable to delete files fitting certain criteria.
Executable to delete files fitting certain criteria.

The intended purpose is to delete backups older than a certain date,
whilst keeping hourly, daily or weekly and so on backups.
whilst keeping hourly, daily or weekly and so on backups.

Specifying an option like --hourly will keep the first file of the hour
and delete the rest of the files created within the same hour,
and delete the rest of the files created within the same hour,
provided that the those files were created before the threshold date.

The executable does not itself create any backups, it is only
The executable does not itself create any backups, it is only
intended for cleaning up existing ones.

== Usage

clean-files file_paths [options]
clean_files file_paths [options]

For help use: clean-files -h
For help use: clean_files -h
== Options

-v, --verbose Print name of files deleted
-p, --pretend Implies -v, only prints what files would have been deleted
-r, --recursive Delete directories as well as files
-t, --threshold Time ago in days for when to start deleting files
File newer than this date are never deleted.
File newer than this date are never deleted.
The default is 30 days.
For example:

For example:

-t 10 or --threshold=30

-H, --hourly Keep hourly files
-D, --daily Keep daily files
-W, --weekly Keep weekly files
Expand Down
2 changes: 1 addition & 1 deletion clean-files.gemspec → clean_files.gemspec
@@ -1,7 +1,7 @@
# -*- encoding: utf-8 -*-

Gem::Specification.new do |s|
s.name = %q{clean-files}
s.name = "clean_files"
s.version = "1.0.1"

s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
Expand Down

0 comments on commit a841524

Please sign in to comment.