Skip to content

Latest commit

 

History

History
212 lines (157 loc) · 14.8 KB

oyranosconfigcs.md

File metadata and controls

212 lines (157 loc) · 14.8 KB

oyranos-config v0.9.7 {#oyranosconfigcs}

NAME SYNOPSIS DESCRIPTION OPTIONS GENERAL OPTIONS ENVIRONMENT VARIABLES EXAMPLES SEE AS WELL AUTHOR COPYRIGHT BUGS

"oyranos-config" 1 "September 23, 2020" "User Commands"

NAME ↑

oyranos-config v0.9.7 - Config

SYNOPSIS ↑

oyranos-config -g=XPATH | -s=XPATH:VALUE | -l | --dump-db | -p [-v] [-z] [-n]
oyranos-config -d[=0|1] [-v]
oyranos-config --syscolordir | --usercolordir | --iccdirname | --settingsdirname | --cmmdir | --metadir [-v] [-z]
oyranos-config --Version | --api-version | --num-version | --git-version [-v]
oyranos-config | --cflags | --ldflags | --ldstaticflags | --sourcedir | --builddir [-v]
oyranos-config -b=SOURCE.c [--cflags] [--ldflags] [--install] [--install-prefix-name=NAME] [-v]
oyranos-config -X=json|json+command|man|markdown | -h[=synopsis|...] | -V | -R=gui|cli|web|... [-v]

DESCRIPTION ↑

The tool can read and set OpenICC DB options, and display paths and static information.

OPTIONS ↑

Persistent Settings

   oyranos-config -g=XPATH | -s=XPATH:VALUE | -l | --dump-db | -p [-v] [-z] [-n]

  Handle OpenICC DB configuration on low level.

-g|--get=XPATH Get a Value
-s|--set=XPATH:VALUE Set a Value
-n|--native-update-event Send native update event
-l|--list List existing paths inside DB
--dump-db Dump OpenICC DB
-p|--path Show DB File

Observe config changes

   oyranos-config -d[=0|1] [-v]

  Will only work on command line.

-d|--daemon[=0|1] Watch DB changes
-d 0# Deactivate : Deactivate
-d 1# Activate : Activate

Show Install Paths

   oyranos-config --syscolordir | --usercolordir | --iccdirname | --settingsdirname | --cmmdir | --metadir [-v] [-z]

  Show statically configured and compiled in paths of Oyranos CMS.

--syscolordir Path to system main color directory
--usercolordir Path to users main color directory
--iccdirname ICC profile directory name
--settingsdirname Oyranos settings directory name
--cmmdir Oyranos CMM directory name
--metadir Oyranos meta module directory name

Show Version

   oyranos-config --Version | --api-version | --num-version | --git-version [-v]

  Release Version follow of a Major(API|ABI)-Minor(Feature)-Micro(Patch|Bug Fix) scheme. For orientation in git the last release, commit number, SHA1 ID and Year-month-day parts are available.

--Version Show official version
API|ABI-Feature-Patch|BugFix Release
--api-version Show version of API
--num-version Show version as a simple number
10000*API+100*Feature+Patch
--git-version Show version as in git
lastReleaseVersion-gitCommitNumber-gitCommitSHA1ID-Year-month-day

Miscellaneous options

   oyranos-config | --cflags | --ldflags | --ldstaticflags | --sourcedir | --builddir [-v]

  These strings can be used to compile programs.

| Project Name
--cflags compiler flags
--ldflags dynamic link flags
--ldstaticflags static linking flags
--sourcedir Oyranos local source directory name
--builddir Oyranos local build directory name

Compile a Module

   oyranos-config -b=SOURCE.c [--cflags] [--ldflags] [--install] [--install-prefix-name=NAME] [-v]

  Install a module from source. Use the --cflags option to pass in compile flags and the --ldflags option to pass in link options for this module. Use ':' string separator for multiple --cflags and --ldflags options.

-b|--build=SOURCE.c build a module
This option is for single file modules.
--install install the module
--install-prefix-name=NAME prepend to file name

GENERAL OPTIONS ↑

General options

   oyranos-config -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
-z|--system-wide System wide DB setting
-v|--verbose upovídaný výstup

ENVIRONMENT VARIABLES ↑

OY_DEBUG

  set the Oyranos debug level.
  Alternatively the -v option can be used.
  Valid integer range is from 1-20.

OY_MODULE_PATH

  route Oyranos to additional directories containing modules.

EXAMPLES ↑

Show a settings value

  oyranos-config -g org/freedesktop/openicc/behaviour/effect_switch

Change a setting

  oyranos-config -s org/freedesktop/openicc/behaviour/effect_switch:1

Show all settings with values

  oyranos-config -l -v

Watch events

  oyranos-config -d 1 -v > log-file.txt

Compile a simple programm

  cc oyranos-config --cflags myFile.c oyranos-config --ldflags -o myProg

Install module from source

  oyranos-config --build=oyranos_cmm_lcm2.c --install --cflags=-fPIC:-fopenmp:-g:-O0 --ldflags=-lm:-llcms2

Show system wide visible profiles from the Oyranos installation path

  ls oyranos-config --syscolordir --iccdirname

SEE AS WELL ↑

  oyranos-policy(1)  oyranos-config-synnefo(1)  oyranos(3)

https://gitlab.com/oyranos/oyranos

AUTHOR ↑

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

COPYRIGHT ↑

© 2005-2024 Kai-Uwe Behrmann and others

Licence

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

BUGS ↑

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