You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2016/08/26 20:25:15 UTC

[08/18] tinkerpop git commit: updated docs

updated docs


Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/e025d30f
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/e025d30f
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/e025d30f

Branch: refs/heads/master
Commit: e025d30fbd979de9753952adaa5ca3c96768242e
Parents: 012bd08
Author: Robert Dale <ro...@gmail.com>
Authored: Fri Aug 19 15:29:48 2016 -0400
Committer: Robert Dale <ro...@gmail.com>
Committed: Fri Aug 19 15:29:48 2016 -0400

----------------------------------------------------------------------
 .../src/reference/gremlin-applications.asciidoc | 53 +++++++++++++++-----
 1 file changed, 41 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e025d30f/docs/src/reference/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc
index 76dd45e..b138e6c 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -150,19 +150,48 @@ some other useful operations.  The following table outlines the most commonly us
 |:submit |:> |Submit Gremlin to the currently active context defined by `:remote`.
 |=========================================================
 
-Gremlin Console adds a special `max-iteration` preference that can be configured with the standard `:set` command
-from the Groovy Shell.  Use this setting to control the maximum number of results that the Console will display.
-Consider the following usage:
+Console Preferences
+~~~~~~~~~~~~~~~~~~~
 
-[gremlin-groovy]
-----
-:set max-iteration 10
-(0..200)
-:set max-iteration 5
-(0..200)
-----
+Preferences are set with `:set name value`.  Value can not contain spaces. Preferences are removed by `:purge preferences`
+
+[width="100%",cols="3,^2,10",options="header"]
+|=========================================================
+|Preference |Type |Description
+|max-iteration | int | Controls the maximum number of results that the Console will display. Default: 100 results.
+|gremlin.color | colors | Color of the ASCII art gremlin on startup.
+|info.color | colors | Color of "info" type messages.
+|error.color | colors | Color of "error" type messages.
+|vertex.color | colors | Color of vertices results.
+|edge.color | colors | Color of edges in results.
+|string.color | colors | Colors of strings in results.
+|number.color | colors | Color of numbers in results.
+|T.color | colors| Color of Tokens in results.
+|input.prompt.color | colors | Color of the input prompt.
+|result.prompt.color | colors | Color of the result prompt.
+|input.prompt | string | Text of the input prompt.
+|result.prompt | string | Text of the result prompt.
+|empty.result.indicator | string | Text of the void/no results indicator.
+|=========================================================
+
+Colors can contain a comma-separated combination of 1 each of foreground, background, and attribute.
+
+[width="100%",cols="3,^2,10",options="header"]
+|=========================================================
+|Foreground |Background |Attributes
+|black|bg_black|bold
+|blue|bg_blue|faint
+|cyan|bg_cyan|underline
+|green|bg_green|
+|magenta|bg_magenta|
+|red|bg_red|
+|white|bg_white|
+|yellow|bg_yellow|
+|=========================================================
+
+Example:
+```:set gremlin.color bg_black,green,bold```
 
-If this setting is not present, the console will default the maximum to 100 results.
 
 Dependencies and Plugin Usage
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1838,7 +1867,7 @@ g.V.map{it.name}  // sugar
 Utilities Plugin
 ~~~~~~~~~~~~~~~~
 
-The Utilities Plugin provides various functions, helper methods and imports of external classes that are useful in the console.  
+The Utilities Plugin provides various functions, helper methods and imports of external classes that are useful in the console.
 
 NOTE: The Utilities Plugin is enabled in the Gremlin Console by default.