debian man page for sur

SUR(1)																	    SUR(1)

NAME
       sur - subtle user repository

SYNOPSIS
       sur COMMAND OPTIONS

DESCIPTION
       sur is the subtle user repository and a manager for sublets in a rubygems like fashion.

       The  main  goal	of sur is to help the user managing sublets and to have a central point where new sublets can be found. Addionally sur has
       some capabilities to create and test sublets.

COMMANDS
       o   sur annotate NAME [-v VERSION|-h]
	   Mark a sublet as to be reviewed

       o   sur build SPEC
	   Create a sublet package

       o   sur config NAME
	   Show available config settings of a sublet

       o   sur fetch NAME
	   Download sublet to current directory

       o   sur help
	   Show this help and exit

       o   sur grabs NAME
	   Show available grabs provided by a sublet

       o   sur info NAME
	   Show info about an installed sublet

       o   sur install NAME [-R|-t|-v VERSION|-h]
	   Install a sublet

       o   sur list [-l|-r|-h]
	   List local/remote sublets

       o   sur notes NAME
	   Show notes about a sublet

       o   sur query NAME [-e|-l|-r|-t|-v VERSION|-h]
	   Query for a sublet (e.g clock, clock -v 0.3)

       o   sur reorder
	   Reorder installed sublets for loading order

       o   sur server [-p PORT|-h]
	   Serve sublets (default: http://localhost:4567)

       o   sur submit FILE
	   Submit a sublet to SUR

       o   sur template FILE
	   Create a new sublet template in current dir

       o   sur test NAME [-C VALUE|-h]
	   Test given sublets for syntax and functionality

       o   sur uninstall NAME [-R|-t|-v VERSION|-h]
	   Uninstall a sublet

       o   sur unpack NAME [-t|-v VERSION|-h]
	   Unpack a sublet in current directory

       o   sur update [-l|-r|-h]
	   Update local/remote sublet cache

       o   sur upgrade [-R|-y|-h]
	   Upgrade all installed sublets

       o   sur version
	   Show version info and exit

       o   sur yank NAME
	   Delete sublet from server

OPTIONS
       o   annotate NAME [-v VERSION|-h]
	   -v, --version VERSION Annotate a specific version
	   -h, --help Show this help and exit

       o   fetch NAME [-t|-v VERSION|-h]
	   -t, --tags Include tags in search
	   -v, --version VERSION Annotate a specific version
	   -h, --help Show this help and exit

       o   install NAME [-R|-t|-v VERSION|-h]
	   -R, --reload Reload sublets after installing
	   -t, --tags Include tags in search
	   -v, --version VERSION Search for a specific version
	   -h, --help Show this help and exit

       o   list [-l|-r|-h]
	   -l, --local Select local repository (default)
	   -r, --remote Select remote repository
	   -h, --help Show this help and exit

       o   query NAME [-e|-l|-r|-t|-v VERSION|-h]
	   -e, --regex Use regex for query
	   -l, --local Select local repository (default)
	   -r, --remote Select remote repository
	   -t, --tags Include tags in search
	   -v, --version VERSION Search for a specific version
	   -h, --help Show this help and exit

       o   server [-p PORT|-h]
	   -p, --port Select a specific port
	   -h, --help Show this help and exit

       o   test NAME [-C VALUE|-h]
	   -C, --config VALUE Add config value (can be used multiple times)
	   -h, --help Show this help and exit

       o   unpack NAME [-t|-v VERSION|-h]
	   -t, --tag Search for a specific tag
	   -v, --version VERSION Search for a specific version
	   -h, --help Show this help and exit

       o   uninstall NAME [-R|-t|-v VERSION|-h]
	   -R, --reload Reload sublets after installing
	   -t, --tag Search for a specific tag
	   -v, --version VERSION Search for a specific version
	   -h, --help Show this help and exit

       o   update [-l|-r|-h]
	   -l, --local Select local repository (default)
	   -r, --remote Select remote repository
	   -h, --help Show this help and exit

       o   upgrade [-R|-y|-h]
	   -R, --reload Reload sublets after upgrading
	   -y, --yes Assume yes to questions
	   -h, --help Show this help and exit

EXAMPLES
       sur install clock
       sur query -r clock
       sur uninstall -v 0.1 clock

SPECIFICATION
       In order to create a sublet, you need to create a specifiction which basically contains some information about your sublet.

       Here is a list of known attributes:

       o   name
	   Name of the sublet

	   Example: spec.name = "Sublet"

       o   version
	   Version of the sublet

	   Example: spec.version = "0.1"

       o   tags
	   List of tags to categorize the sublet

	   Example: spec.tags = [ "Broken" ]

       o   files
	   List of files in the sublet

	   Example: spec.files = [ "sublet.rb" ]

       o   icons
	   List of supplied icons

	   Example: spec.icons = [ "icon.xbm" ]

       o   description
	   Description of the sublet

	   Example: spec.description = "A shiny new sublet"

       o   notes
	   Longer description of the sublet

	   Example: spec.notes = <<NOTES
	   "This sublet is just a dummy, have fun with it!"
	   NOTES

       o   authors
	   List of authors of the sublet in case there are more than one

	   Example: spec.authors = [ "You" ]

       o   contact
	   Contact mail address

	   Example: spec.contact = "your@mail.com"

       o   date
	   Date of creation

	   Example: spec.date = "Sat Sep 13 19:00 CET 2008"

       o   config
	   Description of config settings

	   Example: spec.config = [
	   {

	   :name	=> "format_string",
	   :type	=> "string",
	   :description => "Format of the clock (man date)" },
	   :def_value	=> "Default value"

       }
       ]

       o   grabs
	   Description of grabs

	   Example: spec.grabs = [
	   {

	   :SubletTest => "Test grab",

       }
       ]

       o   required_version
	   Required version of subtle

	   Example: spec.required_version = "0.9.10"

       o   add_dependency(name, version)
	   Add a gem dependency

	   Example: spec.add_dependency("a_gem", "0.0")

       If you use the template command sur will create an empty template with a spec file.

BUGS
       Report bugs at http://subforge.org/projects/subtle/issues
       Homepage: http://subtle.subforge.org

COPYRIGHT
       Copyright (c) Christoph Kappel unexist@dorfelite.net

SEE ALSO
       surserver(1), subtle(1), subtler(1), subtlext(1)

								   October 2011 							    SUR(1)