Document menu commands in README
[project/drush_extras.git] / README.txt
1
2 Drush extras
3 ------------
4 Drush extras is a place where auxiliary drush commands may be found.
5 Typically, these "extra" commands are not be suitable for drush core
6 due to limitations; for example, some may only support certain platforms,
7 and others might require customization before use.
8
9 Drush extras welcomes contributions.
10
11
12 Installation Instructions
13 -------------------------
14 Use with drush-4.x or later.
15
16     $ drush dl drush_extras
17
18 This will download drush_extras and place it in your $HOME/.drush
19 folder.  You may also download the release manually from:
20
21     http://drupal.org/project/drush_extras
22
23 You may place drush_extras wherever you want, but if it is not
24 in a standard location for drush commands, you will need to add
25 it to your drush include file search path.  See examples/example.drushrc.php
26 in the drush project for more information.
27
28
29 Drush extras commands
30 ---------------------
31 Here is a brief overview of the commands available in drush_extras.
32 Please see the help text for more information.
33
34
35 PUSHKEY
36
37     drush pushkey user@host.domain.com
38
39         Creates an ssh public/private key pair in $HOME/.ssh, if
40         one does not already exist, and then pushes the public
41         key to the specified remote account.  The password for the
42         destination account must be entered once to push the
43         key over; after the key has been stored on the remote
44         system, subsequent ssh and remote drush commands may be
45         executed using the public/private key pair for authentication.
46
47         IN DRUSH EXTRAS because is is Linux / openssl-specific.
48
49
50 GREP
51
52     drush grep '#regex#' --content-types=node
53
54         Grep through a site's content using PCREs.
55
56         IN DRUSH EXTRAS because it is only applicable to small sites
57         (greping through enormous databases is impractically slow).
58
59
60 BLOCK-CONFIGURE
61
62     drush block-configure --module=block --delta=0 --region=right --wieght=10
63     drush block-disable --module=block --delta=0
64     drush block-show
65
66         Configure, disable or show settings for particular blocks.
67
68   IN DRUSH EXTRAS because site administration commands are not maintained in drush core.
69
70
71 GIVE
72
73     drush give-node 27 bob
74     drush give-comment 7 bob
75
76         Change the ownership of a node or a comment.
77
78         IN DRUSH EXTRAS because site administration commands are not maintained in drush core.
79
80
81 MENU-CREATE
82
83     drush menu-create new_menu "New Menu" "Menu description."
84     drush add-menu-item menu_name "New Link Title" "http://external.com/link/target"
85     menu-list
86     menu-links menu_name
87
88   Create menus, add menu items, and list existing menus and items.
89
90   IN DRUSH EXTRAS because site administration commands are not maintained in drush core.
91
92
93 SQL-HASH
94
95     drush sql-hash
96     drush sql-compare @site1 @site2
97
98         DEPRECATED
99
100       This function is extremely inefficient.  If you'd like to determine
101       whether the CONTENT of two sites has changed, use the following instead:
102
103       $ drush @site sql-query --db-prefix 'select max(nid),max(changed) from {node}'
104
105       Compare the output of this with the target site to see if anything changed.
106
107       If you must use sql-hash or sql-compare, it is recommended to do so
108       only with the --tables-list option with a small number of tables. For
109       example:
110
111       $ drush sql-compare @site1 @site2 --tables-list=users
112
113       Output hash values for each table in the database, or compare two
114         Drupal sites to determine which tables have different content.  Run
115         before and after an operation on a Drupal site to track table usage.
116
117         IN DRUSH EXTRAS because it is only nominally useful.  Likely to be removed
118     in future releases.