mast 1.2.0 → 1.3.0

data/qed/cli/overview.rdoc

@@ -0,0 +1,133 @@
+= Overview of Mast Command
+
+Mast in a manifest and digest generator.
+
+Let say we have a directory containing a set of files as follows:
+
+  README.txt
+  lib/foo.rb
+  lib/bar.rb
+
+When we invoke the `mast` command from within that directory, we
+will get a complete file listing:
+
+  $ mast
+  #!mast *
+  README.txt
+  lib/bar.rb
+  lib/foo.rb
+
+By default directories are not listed. Using the `-d`/`--dir` option will add
+them:
+
+  $ mast -d
+  #!mast -d *
+  README.txt
+  lib
+  lib/bar.rb
+  lib/foo.rb
+
+Mast can also be used to generate a file digest with the `-g`/`--digest` option.
+For example:
+
+  $ mast -g sha1
+  #!mast -g sha1 *
+  fda3484edf8db0684440157ce0b110d784d42704 README.txt
+  a65255d9e627f654a86f4fd6dfc253566b650b7e lib/bar.rb
+  0d6b06bd4b8b334ac3cde825d155795e3ae951cf lib/foo.rb
+
+Without arguments `mast` will include all files in the current directory
+and subdirectories. To limit the manifest to specific files, we can supply
+them as arguments on the command line. For example:
+
+  $ mast lib
+  #!mast lib
+  lib/bar.rb
+  lib/foo.rb
+
+As with any normal shell command we can use file globs:
+
+  $ mast lib/*.rb
+  #!mast lib/bar.rb lib/foo.rb
+  lib/bar.rb
+  lib/foo.rb
+
+But notice this expands the blob on to the bang line. To keep the glob intact
+put it in quotes:
+
+  $ mast 'lib/*.rb'
+  #!mast lib/*.rb
+  lib/bar.rb
+  lib/foo.rb
+
+To exclude files or directories that might be picked up a file glob,
+use the `-x`/`--exclude` option:
+
+  $ mast -x README.txt
+  #!mast -x README.txt *
+  lib/bar.rb
+  lib/foo.rb
+
+Whereas exclusion elminates exact file and directory matches, `-i`/`--ignore`
+can be used to match an file or directory basename:
+
+  $ mast -i foo.rb
+  #!mast -i foo.rb *
+  README.txt
+  lib/bar.rb
+
+If we would like to save a manifest, we can simply redirect stdout to
+a file name:
+
+  $ mast > MANIFEST.txt
+
+Once saved, `mast` has an update mode via the `-u` option:
+
+  $ mast -u
+  MANIFEST.txt updated.
+
+By default this works for any manifest file with a name matching "manifest{,.*}",
+case insensitvive. An alternate file name can be supplied using the `-f` option.
+
+Mast can also be used to compare a manifest file to the current directory. A simple
+verification that a manifest file matches the current contents of the directory
+can be had via the `-v`/`--verify` option:
+
+  $ mast -v
+  Manifest is good.
+
+To see what files are new, that is to say added to the the directory but not
+listed in the manifest file, use the `-n/--new` option. For instance, let's
+say we have a new file:
+
+  lib/baz.rb
+
+Then using the `-n` option, `lib/baz.rb` will be listed:
+
+  $ mast -n
+  lib/baz.rb
+
+To see what files are _old_, i.e. files listed in the manifest but no longer
+in the in the directory, use `-o`/`--old` option. In this case let's remove
+a file:
+
+  lib/foo.rb
+
+And then the `-o` option will list `lib/foo.rb`:
+
+  $ mast -o
+  lib/foo.rb
+
+Using `--diff` will pass the content of a manifest file and the current
+manifest of the directory to `diff` command. We won't show it here becuase
+`diff` produces absolute paths.
+
+A new manifest can be generated to stdout that uses the options supplied
+on the bang line of a manifest file via the `-b`/`--bang` option:
+
+  $ mast -b
+  #!mast *
+  README.txt
+  lib/bar.rb
+  lib/baz.rb
+

data/ronn/index.txt

@@ -0,0 +1 @@
+mast(1)   mast.1.html

data/ronn/mast.1.ronn

@@ -0,0 +1,89 @@
+mast(1) - manifest generator
+============================
+
+## SYNOPSIS
+
+`mast [<command>] [<options>...]`
+
+## DESCRIPTION
+
+The manifest listing tool is used to list, create or update a
+manifest for a directory (eg. to define a "package"), or compare
+a manifest to actual directory contents. Mast is part of the
+ProUtils set of tools.
+
+When no command is given, a manifest is dumped to standard out.
+If --file is specified, it will generate to that file instead.
+
+## COMMANDS
+
+  * `-c`, `--create`:
+     Generate a new manifest. (default)
+
+  * `-u`, `--update`:
+    Update an existing manifest.
+
+  * `-l`, `--list`:
+    List the files given in the manifest file. (Use -f to specify an alternate file.)
+
+  * `-D`, `--diff`:
+    Diff manifest file against actual.
+
+  * `-n`, `--new`:
+    List existant files that are not given in the manifest.
+
+  * `-o`, `--old`:
+    List files given in the manifest but are non-existent.
+
+  * `-v`, `--verify`:
+    Verify that a manifest matches actual.
+
+  * `--clean`:
+    Remove non-manifest files. (Will ask for confirmation first.)
+
+  * `-h`, `--help`:
+    Display this help message.
+
+## OPTIONS
+
+  * `-a`, `--all`:
+    Include all files. This deactivates deafult exclusions
+    so it is possible to make complete list of all contents.
+
+  * `-d`, `--dir`:
+    When creating a list include directory paths; by default
+    only files are listed.
+
+  * `-b`, `--bang`:
+    Generate manifest using the options from the bang line of the manifest file.
+
+  * `-f`, `--file PATH`:
+    Path to manifest file. This applies to comparison commands.
+    If not given then the file matching 'MANIFEST', case-insensitive
+    and with an optional '.txt' extension, in the current directory
+    is used. If the path of the manifest file is anything else then
+    the --file option must be specified.
+
+  * `-g`, `--digest TYPE`:
+    Include crytographic signiture. Type can be either
+    md5, sha1, sha128, sha256, or sha512.
+
+  * `-x`, `--exclude PATH`:
+    Exclude a file or dir from the manifest matching against
+    full pathname. You can use --exclude repeatedly.
+
+  * `-i`, `--ignore PATH`:
+    Exclude a file or dir from the manifest matching against 
+    an entries basename. You can use --ignore repeatedly.
+
+  * `-q`, `--quiet`:
+    Suppress any extraneous output.
+
+## EXAMPLES
+
+`mast`<br>
+`mast -u -f PUBLISH`
+
+## SEE ALSO
+
+ls(1)

metadata

@@ -1,86 +1,114 @@
 --- !ruby/object:Gem::Specification 
 name: mast
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
-- "- Thomas Sawyer <transfire@gmail.com>"
+- Thomas Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-02-19 00:00:00 -05:00
+date: 2010-11-20 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
-description: |-
-  Mast is a command line tool for generating manifests and digests.
-  Mast makes it easy to compare a manifest to a current directory structure,
-  and to update the manifest with a simple command by storing the command
-  option it the manifest file itself.
-email: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: syckle
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: qed
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Mast is a command line tool for generating manifests and digests. Mast makes it easy to compare a manifest to a current directory structure, and to update the manifest with a simple command by storing the command option it the manifest file itself.
+email: proutils@googlegroups.com
 executables: 
 - mast
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
 - bin/mast
 - lib/mast/cli.rb
 - lib/mast/core_ext.rb
 - lib/mast/manifest.rb
+- lib/mast/meta/data.rb
+- lib/mast/meta/package
+- lib/mast/meta/profile
 - lib/mast.rb
 - lib/plugins/syckle/mast.rb
-- meta/authors
-- meta/contact
-- meta/description
-- meta/download
-- meta/homepage
-- meta/name
-- meta/repository
-- meta/ruby
-- meta/sitemap
-- meta/suite
-- meta/summary
-- meta/version
-- meta/wiki
+- man/man1/mast.1
+- meta/data.rb
+- meta/package
+- meta/profile
+- qed/cli/applique/env.rb
+- qed/cli/overview.rdoc
+- ronn/index.txt
+- ronn/mast.1.ronn
 - HISTORY.rdoc
 - LICENSE
 - README.rdoc
 has_rdoc: true
 homepage: http://proutils.github.com/mast
-licenses: []
-
+licenses: 
+- ""
 post_install_message: 
 rdoc_options: 
 - --title
 - Mast API
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: mast
-rubygems_version: 1.3.6.pre.3
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Mast is a command line tool for generating manifests and digests.

data/meta/authors

@@ -1 +0,0 @@
-- Thomas Sawyer <transfire@gmail.com>

data/meta/contact

@@ -1 +0,0 @@
-proutils@googlegroups.com

data/meta/description

@@ -1,4 +0,0 @@
-Mast is a command line tool for generating manifests and digests.
-Mast makes it easy to compare a manifest to a current directory structure,
-and to update the manifest with a simple command by storing the command
-option it the manifest file itself.

data/meta/download

@@ -1 +0,0 @@
-http://github.com/proutils/mast/downloads

data/meta/homepage

@@ -1 +0,0 @@
-http://proutils.github.com/mast

data/meta/name

@@ -1 +0,0 @@
-mast

data/meta/repository

@@ -1 +0,0 @@
-git://github.com/proutils/mast.git

data/meta/ruby

@@ -1,3 +0,0 @@
----
-- 1.8.6
-- 1.8.7

data/meta/sitemap

@@ -1 +0,0 @@
-doc/rdoc: mast

data/meta/suite

@@ -1 +0,0 @@
-proutils

data/meta/summary

@@ -1 +0,0 @@
-Mast is a command line tool for generating manifests and digests.

data/meta/version

@@ -1 +0,0 @@
-1.2.0

data/meta/wiki

@@ -1 +0,0 @@
-http://wiki.github.com/proutils/mast/