Skip to content

Latest commit

 

History

History
187 lines (135 loc) · 10.8 KB

oyranospolicy.md

File metadata and controls

187 lines (135 loc) · 10.8 KB

oyranos-policy v0.9.7 {#oyranospolicy}

NAME SYNOPSIS DESCRIPTION OPTIONS GENERAL OPTIONS ENVIRONMENT EXAMPLES SEE ALSO AUTHOR COPYRIGHT BUGS

"oyranos-policy" 1 "February 13, 2015" "User Commands"

NAME

oyranos-policy v0.9.7 - Oyranos CMS policy tool

SYNOPSIS

oyranos-policy -c [-f] [-e] [-v]
oyranos-policy -l [-f] [-e] [-v]
oyranos-policy -d [-v]
oyranos-policy -i=FILENAME [-v]
oyranos-policy -p [-v]
oyranos-policy -s=FILENAME [--system-wide] [-v]
oyranos-policy --long-help | --docbook [--doc-title=TEXT] [--doc-version=TEXT]
oyranos-policy -X=json|json+command|man|markdown | -h[=synopsis|...] | -V | -R=gui|cli|web|... [-v]

DESCRIPTION

The tool dumps out / read a configuration of the Oyranos color management system (CMS).

OPTIONS

Current policy

   oyranos-policy -c [-f] [-e] [-v]

-c|--current-policy Show current active policy name

List available policies

   oyranos-policy -l [-f] [-e] [-v]

-l|--list-policies List available policies
-f|--file-name Show full filename including path.
-e|--internal-name Show display name.

Dump out the actual settings

   oyranos-policy -d [-v]

-d|--dump Dump out all settings in Oyranos' own xml-ish text format

Select active policy

   oyranos-policy -i=FILENAME [-v]

-i|--import-policy=FILENAME Must be in Oyranos' own xml-ish text format

List search paths

   oyranos-policy -p [-v]

-p|--list-paths List search paths

Save to a new policy

   oyranos-policy -s=FILENAME [--system-wide] [-v]

-s|--save-policy=FILENAME Save and Install to a new policy
--system-wide Do system wide, might need admin or root privileges

Documentation

   oyranos-policy --long-help | --docbook [--doc-title=TEXT] [--doc-version=TEXT]

--long-help Generate Oyranos Documentation
HTML Format
--docbook Generate Oyranos Documentation
Docbook Format
--doc-title=TEXT
--doc-version=TEXT

GENERAL OPTIONS

General options

   oyranos-policy -X=json|json+command|man|markdown | -h[=synopsis|...] | -V | -R=gui|cli|web|... [-v]

-h|--help[=synopsis|...] Print help text
Show usage information and hints for the tool.
-h -# Full Help : Print help for all groups
-h synopsis# Synopsis : List groups - Show all groups including syntax
-X|--export=json|json+command|man|markdown Export formated text
Get UI converted into text formats
-X man# Man : Unix Man page - Get a unix man page
-X markdown# Markdown : Formated text - Get formated text
-X json# Json : GUI - Get a Oyjl Json UI declaration
-X json+command# Json + Command : GUI + Command - Get Oyjl Json UI declaration incuding command
-X export# Export : All available data - Get UI data for developers. The format can be converted by the oyjl-args tool.
-R|--render=gui|cli|web|... Select Renderer
Select and possibly configure Renderer. -R="gui" will just launch a graphical UI. -R="web:port=port_number:https_key=TLS_private_key_filename:https_cert=TLS_CA_certificate_filename:css=layout_filename.css" will launch a local Web Server, which listens on local port.
-R gui# Gui : Show UI - Display a interactive graphical User Interface.
-R cli# Cli : Show UI - Print on Command Line Interface.
-R web# Web : Start Web Server - Start a local Web Service to connect a Webbrowser with. Use the -R=web:help sub option to see more information.
-R -
-V|--version Version
-v|--verbose verbose

ENVIRONMENT

OY_DEBUG

  set the Oyranos debug level.

XDG_CONFIG_HOME

  route Oyranos to top directories containing resources. The derived paths for policies have a "color/settings" appended.
  http://www.oyranos.com/wiki/index.php?title=OpenIccDirectoryProposal

EXAMPLES

Dump out the actual settings

  oyranos-policy -d

Set new policy

  oyranos-policy -i policy_filename

List available policies

  oyranos-policy -l

Currently active policy including its file name

  oyranos-policy -cfe

Save and Install to a new policy

  oyranos-policy -s policy_name

Print a help text

  oyranos-policy -h

SEE ALSO

  oyranos-config(3)  oyranos-monitor(1)  oyranos(3)

https://gitlab.com/oyranos/oyranos

AUTHOR

Kai-Uwe Behrmann https://gitlab.com/beku

COPYRIGHT

© 2005-2024 Kai-Uwe Behrmann and others

License

newBSD https://gitlab.com/oyranos/oyranos

BUGS

https://www.gitlab.com/oyranos/oyranos/issues