From 7f0354febb4c5f630db772c5d02c466629f31708 Mon Sep 17 00:00:00 2001 From: apoorv Date: Mon, 30 Mar 2020 20:59:33 +0530 Subject: [PATCH 1/5] add reference to env variables & tokens --- content/docs/Reference/env-variables.md | 70 +++++++++++++++++++++++++ content/docs/Reference/tokens.md | 38 ++++++++++++++ 2 files changed, 108 insertions(+) create mode 100644 content/docs/Reference/env-variables.md create mode 100644 content/docs/Reference/tokens.md diff --git a/content/docs/Reference/env-variables.md b/content/docs/Reference/env-variables.md new file mode 100644 index 00000000..74ca3808 --- /dev/null +++ b/content/docs/Reference/env-variables.md @@ -0,0 +1,70 @@ +--- +title: "Environment Variables" +linkTitle: "Environment Variables" +date: 2019-03-30 +weight: 4 +description: > + Reference for common environment variables +--- + +This page list some of the most common environment variables used in OpenCUE. + +## Outline + +Environment variables related to pyOutline. + +##### OL_BASE_SESSION_PATH + + +##### OL_LAYER_SESSION_PATH + + +##### OL_LAYER_RANGE + + +##### OL_VERSION + + +##### OL_OS + + +##### OL_TAG_OVERRIDE + + +##### OL_CONFIG + +## CueBOT + +Environment variables related to CueBOT. + +##### CUEBOT_HOSTS + + +##### CUEBOT_GRPC_CUE_PORT + + +##### CUEBOT_GRPC_RQD_SERVER_PORT + + +## Others + + +##### CUEGUI_DEFAULT_INI_PATH + + +##### OPENCUE_CONF + + +##### CUESUBMIT_CONFIG_FILE + + +##### CUE_FRAME_LOG_DIR + + +##### CUE_FS_ROOT + + +##### CUE_PYTHON_BIN + + +##### CUE_PYTHONPATH diff --git a/content/docs/Reference/tokens.md b/content/docs/Reference/tokens.md new file mode 100644 index 00000000..99a15cc4 --- /dev/null +++ b/content/docs/Reference/tokens.md @@ -0,0 +1,38 @@ +--- +title: "Tokens" +linkTitle: "Tokens" +date: 2019-03-30 +weight: 5 +description: > + Various tokens that can be used in the commands you send to Cue +--- + +Tokens can be used in the commands when submitting outline jobs, either inthe graphical Cuesubmit client, or via the PyOutline API. + +Following are the commonly used tokens: + + +##### #ZFRAME# + To be added. + +##### #IFRAME# + The number of the current frame. + +##### #FRAME_START# + The number of the final frame in the current chunk. + +##### #FRAME_END# + The number of the final frame in the current chunk. + +##### #FRAME_CHUNK# + The value of the current chunk. + +##### #LAYER# + The name of the current layer. + +##### #JOB# + The name of the current job. + +##### #FRAMESPEC# + The value of the current frame spec. A frame spec consists + From 1fb25ae9df322c837085e5dd3bd91f7042edcdb2 Mon Sep 17 00:00:00 2001 From: apoorv Date: Fri, 3 Apr 2020 22:27:04 +0530 Subject: [PATCH 2/5] updated suggestions --- content/docs/Reference/env-variables.md | 49 +++++++++++++------------ content/docs/Reference/tokens.md | 23 ++++++------ 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/content/docs/Reference/env-variables.md b/content/docs/Reference/env-variables.md index 74ca3808..f54e31f5 100644 --- a/content/docs/Reference/env-variables.md +++ b/content/docs/Reference/env-variables.md @@ -1,70 +1,71 @@ --- -title: "Environment Variables" -linkTitle: "Environment Variables" -date: 2019-03-30 +title: "Environment variables" +linkTitle: "Environment variables" +date: 2025-01-01 weight: 4 description: > - Reference for common environment variables + Configure common environment variables + --- -This page list some of the most common environment variables used in OpenCUE. +This page lists some of the most common environment variables used in OpenCue. ## Outline Environment variables related to pyOutline. -##### OL_BASE_SESSION_PATH +### OL_BASE_SESSION_PATH -##### OL_LAYER_SESSION_PATH +### OL_LAYER_SESSION_PATH -##### OL_LAYER_RANGE +### OL_LAYER_RANGE -##### OL_VERSION +### OL_VERSION -##### OL_OS +### OL_OS -##### OL_TAG_OVERRIDE +### OL_TAG_OVERRIDE -##### OL_CONFIG +### OL_CONFIG -## CueBOT +## Cuebot -Environment variables related to CueBOT. +Environment variables related to Cuebot. -##### CUEBOT_HOSTS +### CUEBOT_HOSTS -##### CUEBOT_GRPC_CUE_PORT +### CUEBOT_GRPC_CUE_PORT -##### CUEBOT_GRPC_RQD_SERVER_PORT +### CUEBOT_GRPC_RQD_SERVER_PORT ## Others -##### CUEGUI_DEFAULT_INI_PATH +### CUEGUI_DEFAULT_INI_PATH -##### OPENCUE_CONF +### OPENCUE_CONF -##### CUESUBMIT_CONFIG_FILE +### CUESUBMIT_CONFIG_FILE -##### CUE_FRAME_LOG_DIR +### CUE_FRAME_LOG_DIR -##### CUE_FS_ROOT +### CUE_FS_ROOT -##### CUE_PYTHON_BIN +### CUE_PYTHON_BIN -##### CUE_PYTHONPATH +### CUE_PYTHONPATH diff --git a/content/docs/Reference/tokens.md b/content/docs/Reference/tokens.md index 99a15cc4..99380ce9 100644 --- a/content/docs/Reference/tokens.md +++ b/content/docs/Reference/tokens.md @@ -1,38 +1,37 @@ --- title: "Tokens" linkTitle: "Tokens" -date: 2019-03-30 +date: 2020-04-03 weight: 5 description: > Various tokens that can be used in the commands you send to Cue --- -Tokens can be used in the commands when submitting outline jobs, either inthe graphical Cuesubmit client, or via the PyOutline API. +Tokens can be used in the commands when submitting outline jobs, either in the graphical Cuesubmit client, or via the PyOutline API. Following are the commonly used tokens: - ##### #ZFRAME# - To be added. + The frame number zero-padded to four places. -##### #IFRAME# +##### #IFRAME# The number of the current frame. -##### #FRAME_START# +##### #FRAME_START# The number of the final frame in the current chunk. -##### #FRAME_END# +##### #FRAME_END# The number of the final frame in the current chunk. -##### #FRAME_CHUNK# +##### #FRAME_CHUNK# The value of the current chunk. -##### #LAYER# +##### #LAYER# The name of the current layer. -##### #JOB# +##### #JOB# The name of the current job. -##### #FRAMESPEC# - The value of the current frame spec. A frame spec consists +##### #FRAMESPEC# + The value of the current frame spec. From cf4b9471f35d43e93cee7ef79eca9c6202af047f Mon Sep 17 00:00:00 2001 From: apoorv Date: Sat, 4 Apr 2020 12:14:25 +0530 Subject: [PATCH 3/5] adding line breaks --- content/docs/Reference/tokens.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/Reference/tokens.md b/content/docs/Reference/tokens.md index 99380ce9..9c2b344f 100644 --- a/content/docs/Reference/tokens.md +++ b/content/docs/Reference/tokens.md @@ -7,7 +7,8 @@ description: > Various tokens that can be used in the commands you send to Cue --- -Tokens can be used in the commands when submitting outline jobs, either in the graphical Cuesubmit client, or via the PyOutline API. +Tokens can be used in the commands when submitting outline jobs, either in the graphical Cuesubmit +client, or via the PyOutline API. Following are the commonly used tokens: From 06e68ccb6bc7693400a9e2ab86a1c117a3bd7714 Mon Sep 17 00:00:00 2001 From: apoorv Date: Thu, 9 Apr 2020 21:49:58 +0530 Subject: [PATCH 4/5] updating tokens doc --- content/docs/Reference/tokens.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/content/docs/Reference/tokens.md b/content/docs/Reference/tokens.md index 9c2b344f..fc183473 100644 --- a/content/docs/Reference/tokens.md +++ b/content/docs/Reference/tokens.md @@ -4,13 +4,11 @@ linkTitle: "Tokens" date: 2020-04-03 weight: 5 description: > - Various tokens that can be used in the commands you send to Cue +Specify dynamic tokens in OpenCue jobs --- -Tokens can be used in the commands when submitting outline jobs, either in the graphical Cuesubmit -client, or via the PyOutline API. - -Following are the commonly used tokens: +This page describes tokens you can use in commands when submitting OpenCue jobs, either in the +graphical Cuesubmit client, or using the PyOutline API. ##### #ZFRAME# The frame number zero-padded to four places. From abfa8a3e353c3aa229b5d6ecfe29b20016dbe613 Mon Sep 17 00:00:00 2001 From: apoorv Date: Fri, 10 Apr 2020 11:25:34 +0530 Subject: [PATCH 5/5] indentation fixes --- content/docs/Reference/tokens.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/Reference/tokens.md b/content/docs/Reference/tokens.md index fc183473..5eb34a8e 100644 --- a/content/docs/Reference/tokens.md +++ b/content/docs/Reference/tokens.md @@ -4,7 +4,7 @@ linkTitle: "Tokens" date: 2020-04-03 weight: 5 description: > -Specify dynamic tokens in OpenCue jobs + Specify dynamic tokens in OpenCue jobs --- This page describes tokens you can use in commands when submitting OpenCue jobs, either in the