Using lodspk.sh

Alvaro Graves edited this page May 13, 2013 · 18 revisions
Clone this wiki locally

What's first

Let's get to it

utils/lodspk.sh provides a series of functionalities that makes easier for developers to create components in LODSPeaKr. The syntax for using lospk.sh from the lodspeakr/ directory is:

$ utils/lodspk.sh function parameters

Current functions are:

  • add Add a new endpoint/namespace. It the endpoint or namespace prefix already exist, this command will overwrite it.
    • utils/lodspk.sh add endpoint prefix http://localhost:8890/sparql
    • utils/lodspk.sh add namespace ex http://example.org/
  • backup Creates a backup of settings.inc.php, components and static directories in $HOME/lodspeakr_backup
    • utils/lodspk.sh backup
  • create uri, type or service components.
    • utils/lodspk.sh create uri local:myUri
    • utils/lodspk.sh create type foaf:Person
    • utils/lodspk.sh create service myService
  • delete uri, type or service component.
    • utils/lodspk.sh delete uri local:myUri
    • utils/lodspk.sh delete type foaf:Person
    • utils/lodspk.sh delete service myService
  • debug turns debug output (in apache logs as well as in the browser) on and off:
    • utils/lodspk.sh debug on
    • utils/lodspk.sh debug off
  • default Disables all the URI components and uses Type components only serving the rdfs:Resource model and view
    • utils/lodspk.sh default on
    • utils/lodspk.sh default off
  • disable Disables a specific module
    • Example: utils/lodspk.sh disable module static will remove it from the stack of modules that will be executed.
  • enable Enables a specific module and puts it in a specific position in the stack of active modules
    • Example: utils/lodspk.sh enable module static 2 will put the static module in the 2nd position (positions starts at 0). This module will be executed if the previous 2 modules are not.
  • list List all the components/endpoints/modules/namespaces used by this instance of LODSPeaKr
    • utils/lodspk.sh list components
    • utils/lodspk.sh list endpoints
    • utils/lodspk.sh list modules
    • utils/lodspk.sh list namespaces
  • remove Removes an existing endpoint/namespace. Be aware that endpoints/namespaces included in LODSPeaKr cannot be removed using lodspk.sh. If a namespace/endpoint was overwritten by the user, removing it will turn it into the default namespace or endpoint.
    • utils/lodspk.sh remove endpoint prefix
    • utils/lodspk.sh remove namespace ex
  • restore Restores a previoulsy existing backup form $HOME/lodspeakr_backup/
    • utils/lodspk.sh restore
  • update Performs an update of the LODSPeaKr engine. See Update LODSPeaKr for more information
    • utils/lodspk.sh update
  • version Returns the version of LODSPeaKr
    • utils/lodspk.sh version

What's next