Command Line Tools - Revision history

Nathan Yergler at 17:17, 20 February 2007

2007-02-20T17:17:01Z

Nathan Yergler at 17:14, 20 February 2007

2007-02-20T17:14:01Z

Jon Phillips at 00:44, 24 April 2006

2006-04-24T00:44:42Z

Jon Phillips at 00:43, 24 April 2006

2006-04-24T00:43:39Z

Nathan Yergler: CmdLineTools moved to Command Line Tools

2006-01-04T12:19:23Z

CmdLineTools moved to Command Line Tools

Nathan Yergler at 12:06, 4 January 2006

2006-01-04T12:06:48Z

Nathan Yergler at 12:02, 4 January 2006

2006-01-04T12:02:32Z

Nathan Yergler at 11:59, 4 January 2006

2006-01-04T11:59:40Z

New page

= CC Command Line Tools =

The CC Command Line Interface Tools (CLI Tools) are a set of Python scripts which can be used to insert or read license information from the command line. The basic scripts are stored in the <code>cli-tools</code> module in Berlios SVN.

== Getting the CLI Tools From Subversion ==

The primary tool scripts are stored in the <code>cli-tools</code> module in Berlios SVN. The scripts also rely on additional modules, which are tracked using <code>svn:externals</code> properties. To check out a working copy of the trunk from anonymous SVN into a directory named cli-tools, issue the following command (Linux or Mac OS X):

svn checkout svn://svn.berlios.de/cctools/cli-tools/trunk cli-tools

That's it; you're all set.

== Using the CLI Tools ==

This page describes how to use the current command line interface tools. This page assumes you've already [[/Developer/Projects/CmdLine/GetCliTools|checked out]] the tools.

=== cct.py ===

<code>cct.py</code> is used to embed a license claim in a file and generate the cooresponding license RDF. Currently MP3 is the only supported format. Running <code>cct.py</code> with the <code>--help</code> flag will show a simple help screen:

$ python cct.py --help
usage: cct.py [options] filenames
options:
-o HOLDER, --holder=HOLDER
The copyright holder for the files
-y YEAR, --year=YEAR The copyright year for the files
-l LICENSE, --license=LICENSE
URL of the embedded license
-v VALIDATION, --validation=VALIDATION
Validation URL for this file
--version show program's version number and exit
-h, --help show this help message and exit

=== ccl.py ===

<code>ccl.py</code> is used to examine a license claim embedded in a file. If a verification URL is specified, ccl.py will attempt to verify the license claim. Currently MP3 is the only supported format. Running <code>ccl.py</code> with the <code>--help</code> flag will show a simple help screen:

$ python ccl.py --help
usage: ccl.py [options] filenames
options:
-d, --display Display the license claim; do not verify.
--version show program's version number and exit
-h, --help show this help message and exit

=== claim.py ===

<code>claim.py</code> is used to embed a license claim in a file. Unlike cct.py, claim.py does not generate verification RDF, and takes a fully formed TCOP statement instead of the pieces needed to generate one. Currently MP3 is the only supported format. Running <code>claim.py</code> with the <code>--help</code> flag will show a simple help screen:

$ python claim.py --help
usage: claim.py [options] filenames
options:
-t TCOP, --tcop=TCOP Complete copyright statement to embed.
--version show program's version number and exit
-h, --help show this help message and exit

This page contains basic developer documentation for the CC [[/Developer/Projects/CmdLine|CLI Tools]].

== Hacking the CLI Tools ==

=== Adding file formats ===

== Building and Distributing ==

=== Linux ===
=== Mac OS X ===
=== Windows ===

@@ Line 22: / Line 22: @@
    $ python bootstrap/bootstrap.py
-The bootstrap script will download zc.buildout and setuptools, which are required to complete the build process.  After you have bootstrapped your checkout, you can build the software:
+The bootstrap script will download zc.buildout and [http://peak.telecommunity.com/DevCenter/setuptools setuptools], which are required to complete the build process.  After you have bootstrapped your checkout, you can build the software:
    $ ./bin/buildout

← Older revision		Revision as of 00:44, 24 April 2006
Line 1:		Line 1:
−	~~[[Category:CcNutch]]~~
	[[Category:opensource]]		[[Category:opensource]]
	[[Category:Technology]]		[[Category:Technology]]

← Older revision		Revision as of 00:43, 24 April 2006
Line 1:		Line 1:
		+	[[Category:CcNutch]]
		+	[[Category:opensource]]
		+	[[Category:Technology]]
	[[Category:Developer]]		[[Category:Developer]]
	{{incomplete}}		{{incomplete}}

@@ Line 1: / Line 1: @@
 [[Category:Developer]]
-{{stub}}
+{{incomplete}}
 The CC Command Line Interface Tools (CLI Tools) are a set of Python scripts which can be used to insert or read license information from the command line.  The basic scripts are stored in the <code>cli-tools</code> module in Berlios SVN.

← Older revision		Revision as of 12:02, 4 January 2006
Line 1:		Line 1:
−	~~= CC Command Line Tools =~~	+	[[Category:Developer]]
		+	{{stub}}

	The CC Command Line Interface Tools (CLI Tools) are a set of Python scripts which can be used to insert or read license information from the command line. The basic scripts are stored in the <code>cli-tools</code> module in Berlios SVN.		The CC Command Line Interface Tools (CLI Tools) are a set of Python scripts which can be used to insert or read license information from the command line. The basic scripts are stored in the <code>cli-tools</code> module in Berlios SVN.

@@ Line 2: / Line 2: @@
 [[Category:Technology]]
 [[Category:Developer]]
 The CC Command Line Interface Tools (CLI Tools) are a set of Python scripts which can be used to insert or read license information from the command line.  The basic scripts are stored in the <code>cli-tools</code> module in Berlios SVN.
 == Getting the CLI Tools From Subversion ==
-The primary tool scripts are stored in the <code>cli-tools</code> module in Berlios SVN.  The scripts also rely on additional modules, which are tracked using <code>svn:externals</code> properties.  To check out a working copy of the trunk from anonymous SVN into a directory named cli-tools, issue the following command (Linux or Mac OS X):
+The primary tool scripts are stored in the <code>cli-tools</code> module in Berlios SVN.  To check out a working copy of the trunk from anonymous SVN into a directory named cli-tools, issue the following command (Linux or Mac OS X):
-   svn checkout svn://svn.berlios.de/cctools/cli-tools/trunk cli-tools
+   $ svn checkout svn://svn.berlios.de/cctools/cli-tools/trunk cli-tools
 That's it; you're all set.
 == Using the CLI Tools ==
-This page describes how to use the current command line interface tools.  This page assumes you've already [[/Developer/Projects/CmdLine/GetCliTools|checked out]] the tools.
+This page describes how to use the current command line interface tools.  This page assumes you've already checked out and built the tools as described above.
-=== cct.py ===
+=== cct ===
-<code>cct.py</code> is used to embed a license claim in a file and generate the cooresponding license RDF.  Currently MP3 is the only supported format. Running <code>cct.py</code> with the <code>--help</code> flag will show a simple help screen:
+<code>cct</code> is used to embed a license claim in a file and generate the cooresponding license RDF.  Currently MP3 is the only supported format. Running <code>cct</code> with the <code>--help</code> flag will show a simple help screen:
-  $ python cct.py --help
+  $ ./bin/cct --help
-  usage: cct.py [options] filenames
+  usage: cct [options] filenames
   options:
     -o HOLDER, --holder=HOLDER
@@ Line 35: / Line 49: @@
     -h, --help            show this help message and exit
-=== ccl.py ===
+=== ccl ===
-<code>ccl.py</code> is used to examine a license claim embedded in a file.  If a verification URL is specified, ccl.py will attempt to verify the license claim.  Currently MP3 is the only supported format. Running <code>ccl.py</code> with the <code>--help</code> flag will show a simple help screen:
+<code>ccl</code> is used to examine a license claim embedded in a file.  If a verification URL is specified, ccl.py will attempt to verify the license claim.  Currently MP3 is the only supported format. Running <code>ccl</code> with the <code>--help</code> flag will show a simple help screen:
-  $ python ccl.py --help
+  $ ./bin/ccl --help
-  usage: ccl.py [options] filenames
+  usage: ccl [options] filenames
   options:
     -d, --display  Display the license claim; do not verify.
@@ Line 46: / Line 60: @@
     -h, --help     show this help message and exit
-=== claim.py ===
+=== claim ===
-<code>claim.py</code> is used to embed a license claim in a file.  Unlike cct.py, claim.py does not generate verification RDF, and takes a fully formed TCOP statement instead of the pieces needed to generate one.  Currently MP3 is the only supported format. Running <code>claim.py</code> with the <code>--help</code> flag will show a simple help screen:
+<code>claim</code> is used to embed a license claim in a file.  Unlike cct, claim does not generate verification RDF, and takes a fully formed TCOP statement instead of the pieces needed to generate one.  Currently MP3 is the only supported format. Running <code>claim</code> with the <code>--help</code> flag will show a simple help screen:
-  $ python claim.py --help
+  $ python claim --help
-  usage: claim.py [options] filenames
+  usage: claim [options] filenames
   options:
     -t TCOP, --tcop=TCOP  Complete copyright statement to embed.
     --version             show program's version number and exit
     -h, --help            show this help message and exit

← Older revision	Revision as of 12:19, 4 January 2006
(No difference)