This command is a client that provides access to a 4Suite repository and RDF model from the command line. The repository must exist and must be accessible via a 4Suite RPC server.
4ss |
[--help] [--show-commands] |
Name | Description |
---|---|
-h, --help | show detailed help message |
--show-commands | show system command tree |
Command | Description |
---|---|
4ss add | Add an alias or group member to the repository, or an RDF statement to the model |
4ss agent | Set username and password in a subshell |
4ss create | Create a resource in the repository |
4ss delete | Delete a resource from the repository |
4ss export | export an application. |
4ss fetch | Retrieve a resource from the repository |
4ss install | Install/Update/Remove a 4Suite Application |
4ss list | List certain types of resources in the repository |
4ss login | Set username and password in a local password file |
4ss passwd | Set the password for a user in the repository |
4ss rdf | Perform basic operations on the 4Suite RDF model |
4ss remove | Remove a group member from the repository, or an RDF statement from the model |
4ss render | Apply XSLT against an XML document in the repository |
4ss set | Set properties on a resource in the repository |
4ss update | Update the content of a resource in the repository |
This command sets properties, such as access permissions or arbitrary user data, for a resource in the repository. A subcommand specifying which type of property to set is required. See the help message for a subcommand for specific usage info.
4ss set |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss set acl | Sets access control info for a resource in the 4Suite repository. You will be prompted further for the information to add/set/remove |
4ss set owner | Modifies the owner of a resource in the 4Suite repository. |
4ss set strobe | Specifies that a stylesheet should be automatically executed with the XSLT strobe. |
4ss set userdata | Modifies the user data for a User in the 4Suite repository. |
Modifies the owner of a resource in the 4Suite repository. The new owner must be an existing User.
4ss set owner |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] name newowner |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
name | name (repo path) of resource whose owner is being changed |
newowner | user name of the new owner |
Modifies the user data for a User in the 4Suite repository. Can be used to set or replace one name-value pair at a time.
4ss set userdata |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] userName key [value] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
userName | the name of the user on which to set data |
key | the key (name) for the name-value pair |
value | the value for the name-value pair; no value means delete the key |
Specifies that a stylesheet should be automatically executed with the XSLT strobe.
4ss set strobe |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] name |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
name | repository path of stylesheet to set for the strobe |
Sets access control info for a resource in the 4Suite repository. Prompts for specific permissions to add or modify. Requires write access on the resource.
4ss set acl |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] name |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
name | The name (repo path) of the resource. |
This command will use 4xslt to render a source document with an XSLT stylesheet. Both documents must exist in a 4Suite repository. The metadata for a resource in the repository can be the source document.
4ss render |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] [--define=<NAME=VALUE>] path stylesheet... |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Present no output except for errors or any resulting document |
-D, --define=<NAME=VALUE> | Bind a top-level parameter |
Name | Description |
---|---|
path | The path of the source document in the repo. |
stylesheet | The path of a stylesheet in the repo |
This command sets a 4Suite repository user's password. If you have not used the agent or login commands, you will be prompted for a username and password of someone who has write access on the resource.
4ss passwd |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] userName |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
userName | The name of the user for whom to change the password |
This command will create a resource in a 4Suite repository. It requires a subcommand specifying which type of resource to create. See the help message for one of the subcommands for specific usage info.
4ss create |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss create container | Creates a new Container in the 4Suite repository. |
4ss create document | Creates a new XML Document in the 4Suite repository. |
4ss create group | Creates a new Group in the 4Suite repository. |
4ss create rawfile | Creates a new Raw File in the 4Suite repository |
4ss create urireference | Creates a new URI Reference file in the 4Suite repository |
4ss create user | Creates a new User and sets their password in the 4Suite repository |
Creates a new Group in the 4Suite repository.
4ss create group |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--container=<PATH>] groupName |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-c, --container=<PATH> | The container in which to create the group (default: '/ftss/groups') |
Name | Description |
---|---|
groupName | The name of the group to create. |
Creates a new User in the 4Suite repository. Will prompt for the new user's password.
4ss create user |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--container=<PATH>] userName |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-c, --container=<PATH> | The container in which to create the user (default: '/ftss/users') |
Name | Description |
---|---|
userName | The name of the user to create. |
Creates a new URI Reference file in the 4Suite repository. The URI can be external, but the media type will *not* be determined automatically.
4ss create urireference |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--imt=<imt>] name sourceUri |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--imt=<imt> | The referenced resource's Internet Media Type. Default: text/plain. |
Name | Description |
---|---|
name | The name (repo path) of the new URI Reference file |
sourceUri | The URI to reference |
Creates a new Container in the 4Suite repository.
4ss create container |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--create-parents] name |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-r, --create-parents | Recursively build all parent containers to complete the path. |
Name | Description |
---|---|
name | The name (repo path) of container to create |
Creates a new XML Document in the 4Suite repository. This command is used to store XML-based data in the repository. If you are storing non-XML data, see the 'create rawfile' command.
4ss create document |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--imt=<IMT>] [--docdef=<docdef>] [--type=[xml|xslt|schematron|rdf|container|user|xpathdocdef|xsltdocdef|group|alias]] name sourceUri [alias]... |
Name | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-h, --help | show detailed help message | ||||||||||||||||||||
-u, --username=<USER> | connect using the given user name | ||||||||||||||||||||
-a, --anonymous | connect as anonymous user | ||||||||||||||||||||
--password=<PASSWORD> | connect using the given password | ||||||||||||||||||||
-p, --port=<PORT> | the port to connect to | ||||||||||||||||||||
--host=<HOST> | the host to connect to | ||||||||||||||||||||
-i, --imt=<IMT> | The document's Internet Media Type. Default: text/xml. | ||||||||||||||||||||
-D, --docdef=<docdef> | The name of the document definition to use. | ||||||||||||||||||||
-t, --type=[xml|xslt|schematron|rdf|container|user|xpathdocdef|xsltdocdef|group|alias] | The 4SS document type. If none specified, then the type is inferred from the document's content.
Allowed Values:
|
Name | Description |
---|---|
name | The name (repo path) of the new document |
sourceUri | The URI to read the document's content from, or '-' for stdin |
alias | Additional aliases to assign to the new document. |
Creates a new Raw File in the 4Suite repository. This command is used to store non-XML based data in the repository. If you are storing XML data, please see the 'create document' command.
4ss create rawfile |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--imt=<imt>] name sourceUri [alias]... |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--imt=<imt> | The file's Internet Media Type. Default: text/plain. |
Name | Description |
---|---|
name | The name (repo path) of the new file |
sourceUri | The URI to read the file's content from, or '-' for stdin |
alias | Additional aliases to assign to the new file. |
This command lists information about sets of resources in a 4Suite repository.
4ss list |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss list docdefs | Lists all Document Definitions in the 4Suite repository. |
4ss list groups | Lists all Groups in the 4Suite repository. |
4ss list users | Lists all Users in the 4Suite repository. |
Lists all Document Definitions in the 4Suite repository.
4ss list docdefs |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Lists all Users in the 4Suite repository.
4ss list users |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--fullpaths] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-f, --fullpaths | list full paths instead of user names |
Lists all Groups in the 4Suite repository.
4ss list groups |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--fullpaths] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-f, --fullpaths | list full paths instead of group names |
This command will replace the content of a resource in a 4Suite repository, reading in the new content from a local file. A subcommand specifying which type of resource to update is required. See the help message for a subcommand for specific usage info. If you have not used the agent or login commands, you will be prompted for a username and password of someone who has write access on the resource.
4ss update |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss update document | Update a document. |
4ss update extension | Reloads an extension module in the 4Suite repository. |
4ss update rawfile | Updates the content of an existing Raw File in the 4Suite repository. |
Updates the content of an existing XML Document in the 4Suite repository.
4ss update document |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--imt=<imt>] [[--docdef=<docdef>] | [--nodocdef]] name sourceUri |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--imt=<imt> | The internet media type to assign to the document. If not specified it is left unchanged. |
--docdef=<docdef> | The new document definition for this document |
--nodocdef | remove the current doc def |
Name | Description |
---|---|
name | The name (repo path) of the existing document in the repository. |
sourceUri | The URI to read the source from (Use '-' to read it from standard input) |
Reloads an extension module in the 4Suite repository.
4ss update extension |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] module |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
module | The Python module name |
Updates the content of an existing Raw File in the 4Suite repository.
4ss update rawfile |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--imt=<imt>] name sourceUri |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--imt=<imt> | The file's Internet Media Type. Default: no change. |
Name | Description |
---|---|
name | The name (repo path) of the file |
sourceUri | The URI to read the file's content from, or '-' for stdin |
This command is used to remove a certain type of \ relationship between two objects in a 4Suite repository, or to remove a statement from the RDF model. See the help message for one of the subcommands for specific usage info.
4ss remove |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss remove member | Removes a User from a Group in the 4Suite repository. |
4ss remove statement | Removes a statement from the RDF model. |
Removes a User from a Group in the 4Suite repository.
4ss remove member |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] groupName userName |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
groupName | The name of the group. |
userName | The name of the user. |
Removes a statement from the RDF model. You must have write access to the statement.
4ss remove statement |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] subject predicate object [uri] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
subject | The subject of the statement to remove. |
predicate | The predicate of the statement to remove. |
object | The object of the statement to remove. |
uri | The URI of the statement to remove. |
This command is used to create a certain type of relationship between two objects in a 4Suite repository, or to add a statement to the RDF model. See the help message for one of the subcommands for specific usage info.
4ss add |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss add alias | Creates a new Alias for an existing resource in the 4Suite repository. |
4ss add member | Adds a User to a Group in the 4Suite repository. |
4ss add statement | Add a statement to the the RDF model. |
Adds a User to a Group in the 4Suite repository.
4ss add member |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] groupName memberName |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
groupName | The name of the group. |
memberName | The name of the user. |
Creates a new Alias for an existing resource in the 4Suite repository.
4ss add alias |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] alias sourcePath |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
alias | The full repository path of the new alias. |
sourcePath | The path to the resource being aliased. |
Adds a single statement to the RDF model.
4ss add statement |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--scope=<scope>] [--create] [--objtype=<objtype>] subject predicate object [uri] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--scope=<scope> | The scope of the statement |
--create | Create the virtual RDF document representing the scope, if it doesn't already exist |
--objtype=<objtype> | The type of the object. Usually 'resource' or 'literal'. 'literal' by default. |
Name | Description |
---|---|
subject | The subject of the new statement. |
predicate | The predicate of the new statement. |
object | The object of the new statement. |
uri | The URI of the new statement. |
This command allows one to perform basic operations on the 4Suite RDF model. It requires a subcommand specifying what operation is desired. See the help message for each subcommand for specific usage info.
4ss rdf |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss rdf add | Add RDF statements to a given scope |
4ss rdf complete | Perform an RDF complete |
4ss rdf remove | Remove RDF statements from a given scope |
4ss rdf versa | Perform a Versa query |
Adds statements to the RDF model. A single statement can be given via command-line arguments, or multiple statements can be given in an RDF XML file that will be deserialized.
4ss rdf add |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--document=<document>] scope [subject] [predicate] [object] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-d, --document=<document> | Add statements deserialized from the given document |
Name | Description |
---|---|
scope | The scope into which the statements are to be added |
subject | The subject of the new statement |
predicate | The predicate of the new statement |
object | The object of the new statement |
Perform a Versa query
4ss rdf versa |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] [--query-file=<query-file>] [--no-mapping-file] [--scope=<scope>] [query] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Present no output except for errors or any result |
-f, --query-file=<query-file> | A file with the Versa query |
--no-mapping-file | Do not use the user's namespace mapping file |
--scope=<scope> | a scope to restrict the query |
Name | Description |
---|---|
query | The query to perform. Required if --file is not specified |
Perform an RDF "complete": a query that returns, by default, all RDF statements from the combined system and user models.
4ss rdf complete |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--subject=<subject>] [--predicate=<predicate>] [--object=<object>] [--uri=<uri>] [--scope=<scope>] [--xml] [--flat-model] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--subject=<subject> | The subject for the complete |
--predicate=<predicate> | The predicate for the complete |
--object=<object> | The object for the complete |
--uri=<uri> | The URI of the statement to fetch |
--scope=<scope> | The scope of statements to fetch. |
-x, --xml | Generate Serialized RDF in XML format. |
--flat-model | Do not show the results sorted by scope. |
Remove statements from the RDF model. A single statement can be given via command-line arguments, or multiple statements can be given in an RDF XML file that will be deserialized. Only the user model is affected.
4ss rdf remove |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--document=<document>] [--subject=<subject>] [--predicate=<predicate>] [--object=<object>] [--subject-regex] [--predicate-regex] [--object-regex] [scope] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-d, --document=<document> | Remove statements deserialized from the given document |
--subject=<subject> | The subject of statements selected to be deleted |
--predicate=<predicate> | The predicate of statements selected to be deleted |
--object=<object> | The object of statements selected to be deleted |
--subject-regex | The subject string is a regular expression to match |
--predicate-regex | The predicate string is a regular expression to match |
--object-regex | The object string is a regular expression to match |
Name | Description |
---|---|
scope | The scope from which the statements are to be removed |
This command will export an application from the repository and create a setup.xml file. You will be prompted for a user name and password. You must have read access to all of the files in the directory.
4ss export |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--directory=<DIR>] [--version=<VERS>] [--description=<DESC>] [--title=<TITLE>] [--archive=[gztar|ztar|bztar|zip|tar]] [path] |
Name | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
-h, --help | show detailed help message | ||||||||||
-u, --username=<USER> | connect using the given user name | ||||||||||
-a, --anonymous | connect as anonymous user | ||||||||||
--password=<PASSWORD> | connect using the given password | ||||||||||
-p, --port=<PORT> | the port to connect to | ||||||||||
--host=<HOST> | the host to connect to | ||||||||||
-d, --directory=<DIR> | Directory to export to (must already exist) | ||||||||||
--version=<VERS> | Set version of exported application | ||||||||||
--description=<DESC> | Set description of exported application | ||||||||||
--title=<TITLE> | Set title of exported application | ||||||||||
--archive=[gztar|ztar|bztar|zip|tar] | Archive the exported data (options are platform-dependent)
Allowed Values:
|
Name | Description |
---|---|
path | The base directory of the application to export. The default is /. |
This command will set environment variables in a new shell so that you do not need to login as a user for all subsequent invocations of 4ss command-line scripts. This command is an alternative to the login command.
4ss agent |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [shell] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
shell | name of shell to execute (default is system specific) |
This command reads a 4Suite Application's setup XML file from the local filesystem and uses it to install, update or remove the application.
4ss install |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--demo] [--dashboard] [--delete] [--base=<base>] [--quiet] [--no-acl] [setup] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--demo | Install the prepackaged demo |
--dashboard | Install the system dashboard |
-D, --delete | delete an installed product |
-b, --base=<base> | base URI of the product in the repo |
-q, --quiet | Don't display what is happening |
--no-acl | Don't sync ACL (install faster) |
Name | Description |
---|---|
setup | The filename of the setup XML file. If not specified, then you must specify the --demo flag. |
This command will set a user name and password entry into a file (on the local filesystem) that can be used for subsequent invocations of 4ss command-line scripts. The default location of the file is in the current user's home directory. To change the location, set the environment variable FTSS_PASSWORD_FILE. This command is an alternative to the agent command.
4ss login |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [username] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
username | name of user to log in as. |
This command retrieves a resource from a 4Suite repository. It requires a subcommand specifying which type of resource to fetch. See the help message for one of the subcommands for specific usage info.
4ss fetch |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Command | Description |
---|---|
4ss fetch container | List contents of a Container in the 4Suite repository |
4ss fetch docdef | Fetches a Document Definition from the 4Suite repository. |
4ss fetch document | Fetches an XML Document from the 4Suite repository. |
4ss fetch group | Lists information about a Group in the 4Suite repository. |
4ss fetch rawfile | Fetches a Raw File from the 4Suite repository |
4ss fetch resource | Summarizes metadata about a resource in the 4Suite repository. |
4ss fetch user | Lists information about a User in the 4Suite repository. |
4ss fetch userdata | Summarizes the user data for a User in the 4Suite repository. |
Summarizes the user data for a User in the 4Suite repository. Summarizes the keys and values. If no keys are specified, then all of the keys associated with the user are fetched.
4ss fetch userdata |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] userName [key]... |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Don't preface output with informational header |
Name | Description |
---|---|
userName | the name of the user whose data to fetch |
key | the key (name) of a name-value pair; if none, all data for the user will be returned |
Summarizes metadata about a resource in the 4Suite repository The summary includes the resource's name (repo path), type, creation and last modified dates, Internet Media Type, size, owner, and ACL.
4ss fetch resource |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] name |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
name | The name (repo path) of the resource. |
Lists information about a User in the 4Suite repository. Lists the user's password hash, summarizes ACL and group membership.
4ss fetch user |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] userName |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Don't preface output with informational header |
Name | Description |
---|---|
userName | The name of the user for which to fetch info |
Fetches a Raw File from the 4Suite repository. Since most resource types inherit from Raw File, this command can be used to get the content of nearly any file.
4ss fetch rawfile |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] name |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Don't preface output with informational header |
Name | Description |
---|---|
name | The name (repo path) of the resource to fetch. |
Fetches a directory-like listing for a Container in the 4Suite repository. Columns are: Internet Media Type, size, date last modified, relative name.
4ss fetch container |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [name] |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
Name | Description |
---|---|
name | name (repo path) of container to view (default: /) |
Fetches an XML Document from the 4Suite repository.
4ss fetch document |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] name |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Don't preface output with informational header |
Name | Description |
---|---|
name | The name (repo path) of document to fetch |
Fetches a Document Definition from the 4Suite repository. For XSLT based DocDefs, fetches the XSLT document. For XPath based DocDefs, provides a formatted summary.
4ss fetch docdef |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] name |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Don't preface output with informational header |
Name | Description |
---|---|
name | Name (repo path) of document definition to view |
Fetches a Group from the 4Suite repository. Lists the group's members and summarizes its ACL.
4ss fetch group |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--quiet] groupName |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
-q, --quiet | Don't preface output with informational header |
Name | Description |
---|---|
groupName | The name of the group to fetch |
This command will delete a resource from a 4Suite repository. If you have not used the agent or login commands, you will be prompted for a username and password of someone who has write access on the resource.
4ss delete |
[--help] [[--username=<USER>] | [--anonymous]] [--password=<PASSWORD>] [--port=<PORT>] [--host=<HOST>] [--no-traverse] path |
Name | Description |
---|---|
-h, --help | show detailed help message |
-u, --username=<USER> | connect using the given user name |
-a, --anonymous | connect as anonymous user |
--password=<PASSWORD> | connect using the given password |
-p, --port=<PORT> | the port to connect to |
--host=<HOST> | the host to connect to |
--no-traverse | Don't traverse aliases |
Name | Description |
---|---|
path | The path of the resource to delete. This can be a regex expression. |