summaryrefslogtreecommitdiffstats
path: root/README.txt
blob: 68c68b68b2cf24681edcb0c2778301dab716119c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
Drush extras
------------
Drush extras is a place where auxiliary drush commands may be found.
Typically, these "extra" commands are not be suitable for drush core
due to limitations; for example, some may only support certain platforms,
and others might require customization before use.

Drush extras welcomes contributions.


Installation Instructions
-------------------------
Use with drush-4.x or later.

    $ drush dl drush_extras

This will download drush_extras and place it in your $HOME/.drush
folder.  You may also download the release manually from:

    http://drupal.org/project/drush_extras

You may place drush_extras wherever you want, but if it is not
in a standard location for drush commands, you will need to add
it to your drush include file search path.  See examples/example.drushrc.php
in the drush project for more information.


Drush extras commands
---------------------
Here is a brief overview of the commands available in drush_extras.
Please see the help text for more information.


PUSHKEY

    drush pushkey user@host.domain.com

	Creates an ssh public/private key pair in $HOME/.ssh, if
	one does not already exist, and then pushes the public
	key to the specified remote account.  The password for the
	destination account must be entered once to push the
	key over; after the key has been stored on the remote
	system, subsequent ssh and remote drush commands may be
	executed using the public/private key pair for authentication.

	IN DRUSH EXTRAS because is is Linux / openssl-specific.


GREP

    drush grep '#regex#' --content-types=node

	Grep through a site's content using PCREs.

	IN DRUSH EXTRAS because it is only applicable to small sites
	(greping through enormous databases is impractically slow).


BLOCK-CONFIGURE

    drush block-configure --module=block --delta=0 --region=right --wieght=10
    drush block-disable --module=block --delta=0
    drush block-show

	Configure, disable or show settings for particular blocks.

  IN DRUSH EXTRAS because site administration commands are not maintained in drush core.


GIVE

    drush give-node 27 bob
    drush give-comment 7 bob

	Change the ownership of a node or a comment.

	IN DRUSH EXTRAS because site administration commands are not maintained in drush core.


MENU-CREATE

    drush menu-create new_menu "New Menu" "Menu description."
    drush add-menu-item menu_name "New Link Title" "http://external.com/link/target"
    menu-list
    menu-links menu_name

  Create menus, add menu items, and list existing menus and items.

  IN DRUSH EXTRAS because site administration commands are not maintained in drush core.


SQL-HASH

    drush sql-hash
    drush sql-compare @site1 @site2

    	DEPRECATED

      This function is extremely inefficient.  If you'd like to determine
      whether the CONTENT of two sites has changed, use the following instead:

      $ drush @site sql-query --db-prefix 'select max(nid),max(changed) from {node}'

      Compare the output of this with the target site to see if anything changed.

      If you must use sql-hash or sql-compare, it is recommended to do so
      only with the --tables-list option with a small number of tables. For
      example:

      $ drush sql-compare @site1 @site2 --tables-list=users

      Output hash values for each table in the database, or compare two
        Drupal sites to determine which tables have different content.  Run
        before and after an operation on a Drupal site to track table usage.

	IN DRUSH EXTRAS because it is only nominally useful.  Likely to be removed
    in future releases.