From 2c9a0aae32615d757c49df28295a830609b31c4e Mon Sep 17 00:00:00 2001 From: Matt Madia Date: Sun, 5 Dec 2010 13:05:17 +0000 Subject: [PATCH] Added some updates to hey documentation, for 1.2.6 --> 1.2.8 changes. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39737 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- docs/bin/hey.html | 57 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 17 deletions(-) diff --git a/docs/bin/hey.html b/docs/bin/hey.html index 8729e91d131..f06831c9a3c 100644 --- a/docs/bin/hey.html +++ b/docs/bin/hey.html @@ -4,7 +4,7 @@ hey Documentation -

hey version 1.2.6

+

hey version 1.2.8

@@ -19,7 +19,7 @@

Installation

@@ -28,17 +28,17 @@

Installation

Usage

hey should be used from Terminal. When you start it without parameters it will display the command line syntax it accepts: 

-hey v1.2.6, written by Attila Mezei (amezei@mail.datanet.hu)
-usage: hey [-s] <app|signature> [let <specifier> do] <verb> <specifier_1> <of <specifier_n>>* 
-           [to <value>] [with name=<value> [and name=<value>]*]
+hey v1.2.8, written by Attila Mezei (attila.mezei@mail.datanet.hu)
+usage: hey [-s][-o] <app|signature|teamid> [let <specifier> do] <verb> <specifier_1> <of
+           <specifier_n>>* [to <value>] [with name=<value> [and name=<value>]*]
 where  <verb> : DO|GET|SET|COUNT|CREATE|DELETE|GETSUITES|QUIT|SAVE|LOAD|'what'
-  <specifier> : [the] <property_name> [ <index> | name | "name" | '"name"']
-      <index> : index | '['index']' | '['-reverse_index']' | '['fromvalue to tovalue']'
+  <specifier> : [the] <property_name> [ <index> | name | "name" | '"name"' ]
       <index> : int | -int | '['int']' | '['-int']' | '['startint to end']'
-      <value> : "string" | <integer> | <float> | bool(value) | int8(value) |
-                int16(value) | int32(value) | float(value) | double(value) |
-                BPoint(x,y) | BRect(l,t,r,b) | rgb_color(r,g,b,a) | file(path)   
+      <value> : "string" | <integer> | <float> | bool(value) | int8(value)
+                | int16(value) | int32(value) | float(value) | double(value)
+                | BPoint(x,y) | BRect(l,t,r,b) | rgb_color(r,g,b,a) | file(path)
 options: -s: silent
+         -o: output result to stdout for easy parsing

@@ -57,7 +57,7 @@

The verb

  • SAVE: B_SAVE_REQUESTED
  • LOAD: B_REFS_RECEIVED -You can use your own verbs if you specify the value names and constants in the 'value_info' structure. See BPropertyInfo and PropertyInfo.h for details. +You can use your own verbs if you specify the value names and constants in the 'value_info' structure. See BPropertyInfo and PropertyInfo.h for details.

    Note that the verb is not case sensitive but the specifier names (e.g. "Frame", "Label"...) are. You can use 'what' constants directly, like @@ -102,6 +102,29 @@

    DEBUG mode


    History

    +v1.2.8 +
      +
    • + (Sander Stoks): Added command-line option -o which will output the "result" value + in the reply message to stdout, so you can use it in shell scripting more easily: + "hey Becasso get AspectRatio of Canvas 0" + outputs + Reply BMessage(B_REPLY): + "result" (B_DOUBLE_TYPE) : 0.600 + but "hey -o Becasso get AspectRatio of Canvas 0" + outputs 0.600000 directly. +
    +v1.2.7 +
      +
    • + by Sander Stoks: Made a fork since I don't think Attila still supports "hey", and + because the latest version on BeBits seems to be 1.2.4. + Changes w.r.t. 1.2.6: When an application returns an error on a message, hey now + keeps iterating over applications with the same signature. This is useful because, + for instance, Terminal starts as a new process for each instance, so it previously + wouldn't work to move a specific Terminal window using hey. You can now say + "hey Terminal set Frame of Window foo to BRect[...]". +
    v1.2.6
    • syntax extended by Sander Stoks to allow: @@ -132,7 +155,7 @@

      History

      more like english, bare reverse-index-specifiers are now handled, and named specifiers can contain only digits by quoting it (but make sure the shell passes the quotes through). - +
    • Hey(target,const char*,reply) was previously limited to 100 tokens. It now uses a vector<> so it's only limited by available memory. @@ -140,7 +163,7 @@

      History

    v1.2.3
      -
    • new option: -s for silent processing (no reply or errors printed) AM +
    • new option: -s for silent processing (no reply or errors printed) AM
    v1.2.2
      @@ -150,7 +173,7 @@

      History

    v1.2.1
      -
    • compiled for R4 with minor modifications of BPropertyInfo usage +
    • compiled for R4 with minor modifications of BPropertyInfo usage
    v1.2.0
      @@ -170,8 +193,8 @@

      History

    • The range specifier sent to the target was 1 greater than it should've been. Fixed. -
    • 'hey' made the assumption that the first thread in a team will be the - application thread (and therefore have the application's name). +
    • 'hey' made the assumption that the first thread in a team will be the + application thread (and therefore have the application's name). This was not always the case. Fix from Scott Lindsey (wombat@gobe.com).
    v1.1.0 @@ -247,7 +270,7 @@

    Set a view property:

    	hey Network set Frame of View 0 of Window "Network" to 'BRect(0,0,100,400)'
 	hey Network set Hidden of View 0 of View 0 of Window "Network" to true
 	hey Network set Label of View 5 of View 0 of Window "Network" to "Restart Something"
-	hey Network set Value of View 0 of View 2 of View 0 of Window "Network" to 1 
+	hey Network set Value of View 0 of View 2 of View 0 of Window "Network" to 1
 	hey Network set Text of View 2 of View 2 of View 0 of Window "Network" to "joe"

    Close a window in an application