1mNAME0m
       registry - Manipulate the Windows registry

1mSYNOPSIS0m
       1mpackage require registry 1.00m

       1mregistry 4m22moption24m 4mkeyName24m ?4marg24m 4marg24m 4m...24m?


1mDESCRIPTION0m
       The  1mregistry  22mpackage provides a general set of operations for manipu-
       lating the Windows registry.  The package implements the  1mregistry  22mTcl
       command.   This  command  is  only  supported  on the Windows platform.
       Warning: this command should be used with caution as a  corrupted  reg-
       istry can leave your system in an unusable state.

       4mKeyName24m  is  the  name of a registry key.  Registry keys must be one of
       the following forms:

              1m\\4m22mhostname24m1m\4m22mrootname24m1m\4m22mkeypath0m

              4mrootname24m1m\4m22mkeypath0m

              4mrootname0m

       4mHostname24m specifies the name of any valid Windows host that exports  its
       registry.   The  4mrootname24m  component must be one of 1mHKEY_LOCAL_MACHINE22m,
       1mHKEY_USERS22m, 1mHKEY_CLASSES_ROOT22m, 1mHKEY_CURRENT_USER22m,  1mHKEY_CURRENT_CONFIG22m,
       1mHKEY_PERFORMANCE_DATA22m,  or  1mHKEY_DYN_DATA22m.   The  4mkeypath24m can be one or
       more registry key names separated by backslash (1m\22m) characters.

       4mOption24m indicates what to do with the registry  key  name.   Any  unique
       abbreviation for 4moption24m is acceptable.  The valid options are:

       1mregistry delete 4m22mkeyName24m ?4mvalueName24m?
              If  the  optional  4mvalueName24m  argument is present, the specified
              value under 4mkeyName24m will be deleted from the registry.   If  the
              optional 4mvalueName24m is omitted, the specified key and any subkeys
              or values beneath it in the registry hierarchy will be  deleted.
              If  the key could not be deleted then an error is generated.  If
              the key did not exist, the command has no effect.

       1mregistry get 4m22mkeyName24m 4mvalueName0m
              Returns the data associated with the value 4mvalueName24m  under  the
              key  4mkeyName24m.   If  either  the key or the value does not exist,
              then an error is generated.  For more details on the  format  of
              the returned data, see SUPPORTED TYPES, below.

       1mregistry keys 4m22mkeyName24m ?4mpattern24m?
              If  4mpattern24m  isn't specified, returns a list of names of all the
              subkeys of 4mkeyName24m.  If 4mpattern24m is specified, only  those  names
              matching 4mpattern24m are returned.  Matching is determined using the
              same rules as for 1mstring match22m.  If the specified  4mkeyName24m  does
              not exist, then an error is generated.

       1mregistry set 4m22mkeyName24m ?4mvalueName24m 4mdata24m ?4mtype24m??
              If  4mvalueName24m  isn't  specified,  creates  the key 4mkeyName24m if it
              doesn't already exist.  If 4mvalueName24m is specified,  creates  the
              key  4mkeyName24m  and value 4mvalueName24m if necessary.  The contents of
              4mvalueName24m are set to 4mdata24m with the type indicated by  4mtype24m.   If
              4mtype24m  isn't specified, the type 1msz 22mis assumed.  For more details
              on the data and type arguments, see SUPPORTED TYPES below.

       1mregistry type 4m22mkeyName24m 4mvalueName0m
              Returns the type of the value 4mvalueName24m in the key 4mkeyName24m.  For
              more  information  on  the  possible types, see SUPPORTED TYPES,
              below.

       1mregistry values 4m22mkeyName24m ?4mpattern24m?
              If 4mpattern24m isn't specified, returns a list of names of  all  the
              values  of  4mkeyName24m.   If 4mpattern24m is specified, only those names
              matching 4mpattern24m are returned.  Matching is determined using the
              same rules as for 1mstring match22m.


1mSUPPORTED TYPES0m
       Each value under a key in the registry contains some data of a particu-
       lar type in a type-specific representation.  The 1mregistry 22mcommand  con-
       verts  between this internal representation and one that can be manipu-
       lated by Tcl scripts.  In most cases, the data is simply returned as  a
       Tcl string.  The type indicates the intended use for the data, but does
       not actually change the representation.  For some types,  the  1mregistry0m
       command  returns  the  data  in  a  different form to make it easier to
       manipulate.  The following types are recognized by  the  registry  com-
       mand:

       1mbinary           22mThe  registry  value  contains  arbitrary binary data.
                        The data is represented exactly in Tcl, including  any
                        embedded nulls.

       1mnone             22mThe registry value contains arbitrary binary data with
                        no defined type.  The data is represented  exactly  in
                        Tcl, including any embedded nulls.

       1msz               22mThe  registry value contains a null-terminated string.
                        The data is represented in Tcl as a string.

       1mexpand_sz        22mThe registry value contains a  null-terminated  string
                        that  contains  unexpanded  references  to environment
                        variables in the normal Windows  style  (for  example,
                        "%PATH%").   The  data  is  represented  in  Tcl  as a
                        string.

       1mdword            22mThe registry value  contains  a  little-endian  32-bit
                        number.   The  data is represented in Tcl as a decimal
                        string.

       1mdword_big_endian 22mThe registry value contains a big-endian  32-bit  num-
                        ber.   The  data  is  represented  in Tcl as a decimal
                        string.

       1mlink             22mThe registry value contains a symbolic link.  The data
                        is  represented exactly in Tcl, including any embedded
                        nulls.

       1mmulti_sz         22mThe registry value contains an  array  of  null-termi-
                        nated  strings.   The  data is represented in Tcl as a
                        list of strings.

       1mresource_list    22mThe registry value contains a  device-driver  resource
                        list.  The data is represented exactly in Tcl, includ-
                        ing any embedded nulls.

       In addition to the symbolically named types listed above, unknown types
       are identified using a 32-bit integer that corresponds to the type code
       returned by the system interfaces.  In this case, the  data  is  repre-
       sented exactly in Tcl, including any embedded nulls.


1mPORTABILITY ISSUES0m
       The registry command is only available on Windows.


1mKEYWORDS0m
