├── .gitignore ├── COPYING ├── Makefile ├── NEWS ├── README.md ├── RECIPES.md ├── TODO ├── debian ├── README ├── changelog ├── compat ├── control ├── copyright ├── docs ├── rules └── source │ └── format ├── pussh ├── pussh.1 └── test /.gitignore: -------------------------------------------------------------------------------- 1 | debian/files 2 | debian/*.substvars 3 | debian/*.log 4 | debian/pussh/ 5 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | default: 2 | 3 | .PHONY: test 4 | 5 | lint: 6 | @shellcheck pussh 7 | 8 | test: 9 | @./test 10 | 11 | install: 12 | install -D -m755 pussh $(DESTDIR)/usr/bin/pussh 13 | install -D -m644 pussh.1 $(DESTDIR)/usr/share/man/man1/pussh.1 14 | -------------------------------------------------------------------------------- /NEWS: -------------------------------------------------------------------------------- 1 | pussh 1.5 - UNRELEASED 2 | 3 | * Get rid of external commands date, dirname & basename with bashisms 4 | (thanks @stephanebill) 5 | * Add -4/-6 SSH options (thanks @fxlb) 6 | 7 | pussh 1.4 - 2024-08-19 8 | 9 | * Use '/usr/bin/env bash' shebang, more portable (thanks @majal) 10 | 11 | pussh 1.3 - 2024-04-12 12 | 13 | * -h/--hosts now fully support [login@]host[:port] syntax 14 | 15 | pussh 1.2 - 2024-04-12 16 | 17 | * Fully implemented comment/empty ligne ignorance in -f 18 | * Lint'ed with shellcheck 19 | * Safer global '-e' flag 20 | 21 | pussh 1.1 - 2021-10-19 22 | 23 | * Removed host coloring, was inefficient and useless 24 | * Ignoring commented lines (#) from -f|--from-file source (@Mickael-Martin) 25 | 26 | pussh 1.0 - 2013-05-19 27 | 28 | * First public release (being used for 4 years internally at Bearstech) 29 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | pussh 2 | ===== 3 | 4 | Parallel SSH, batch and command line oriented. 5 | 6 | Basic commands, where output is sent prefixed by the host name : 7 | 8 | $ pussh -h host1,host2bis,... uname -a 9 | host1 : Linux host1 3.2.0-4-amd64 #1 SMP Debian 3.2.41-2 x86_64 GNU/Linux 10 | host2bis: Linux host2 3.2.0-3-kirkwood #1 Mon Jul 23 22:36:47 UTC 2012 armv5tel GNU/Linux 11 | ... 12 | 13 | You can fetch the host list from a file or from stdin : 14 | 15 | $ pussh -f servers uname -a 16 | $ fetch-servers | pussh -f - uname -a 17 | 18 | Use it with pipes as you would normally, for instance to sort server by rootfs usage : 19 | 20 | $ pussh -f servers df -h / |grep /dev |sort -rn -k5 21 | 22 | Or collect per-host output, like for inventories : 23 | 24 | $ pussh -f servers -o %h-hw.txt lshw 25 | 26 | And you can even pipe each SSH session output to a specific command (%h is also 27 | available if you wish) : 28 | 29 | $ pussh -f servers -o '|grep feature' command >output 30 | 31 | Obviously, you have the same features for the SSH sessions input : 32 | 33 | $ pussh -f servers -i file command 34 | $ pussh -f servers -i %h.data command 35 | $ pussh -f servers -i 'get-data %h|' command 36 | 37 | You may mix -i and -o freely. 38 | 39 | More interestingly, you can send and execute a command in one go (but it won't 40 | handle the dependencies for you, make sure your executable is self-contained or 41 | your host environment is compatible with the target ones) : 42 | 43 | $ pussh -f servers -u my-deploy.sh args ... 44 | 45 | Most of the time the total time of execution is limited by the SSH connection 46 | establishment rate, and this rate is itself limited by the SSH agent. It is 47 | recommended to tune your rate for a specific host and stick to it. Exceeding 48 | rates generate strange connection errors (such as failed ssh-agent 49 | auths, 'no route to host', etc.). 50 | 51 | $ alias pussh='pussh -r 50' 52 | 53 | Speed is mainly sensitive to network latency. You may first login into one of 54 | your remote LAN machine with ssh forwarding (ssh -A) then run 'pussh' from 55 | there, the closest possible from its targets. Here is a real benchmark 56 | on a Gigabit LAN : 57 | 58 | $ time pussh -f servers -r 100 date 59 | ... 60 | Total: 201 host(s), 4 second(s) 61 | 62 | real 0m4.069s 63 | user 0m7.132s 64 | sys 0m3.140s 65 | 66 | 67 | History 68 | ------- 69 | 70 | Pussh has been an internal tool at Bearstech since roughly 2008. It started 71 | with 4 or 5 lines of shell and quickly evolved to its current form. It's still 72 | heavily used on a 500+ cluster server, and most of the time reach all of its 73 | targets in about 10 seconds. It is coupled to a cloud management solution to 74 | generate a useful list of hosts from very simple descriptions. 75 | 76 | 77 | Limitations 78 | ----------- 79 | 80 | * Remote's stdout and stderr ends mixed up in the same stdout stream. 81 | * There is no way to use the remote exit status. 82 | 83 | -------------------------------------------------------------------------------- /RECIPES.md: -------------------------------------------------------------------------------- 1 | pussh recipes 2 | ============= 3 | 4 | Here you will find useful **pussh** snippets. 5 | 6 | Mass copy a file tree (broadcast) : 7 | 8 | tar czf files.tar.gz ... && pussh -f servers -i files.tar.gz tar -xzC /to/dest 9 | 10 | Mass copy several remote file trees (gather) : 11 | 12 | pussh -f servers -o '|(mkdir -p %h && tar -xzC %h)' tar -czC /src/path . 13 | 14 | Print distinct running kernels with their frequency (histogram) : 15 | 16 | pussh -f servers 'uname -a' |sort |uniq -c |sort -rn 17 | 18 | Find largest files and folders across several hosts (display in MB), where 19 | 'ionice -c3' is optional but recommended : 20 | 21 | pussh -f servers ionice -c3 du -Smax / |sort -rn 22 | 23 | 24 | Debian specific 25 | --------------- 26 | 27 | Show version of installed packages, properly aligned : 28 | 29 | pussh -f servers COLUMNS=120 dpkg -l openssh-server |grep ': ii' 2>/dev/null 30 | pussh -f servers sh -c 'COLUMNS=120 dpkg -l openssh-server |grep ^i 2>/dev/null' 31 | 32 | Or more specific while searching for specific dpkg information : 33 | 34 | pussh -f servers dpkg-query -W -f '${Version}' openssh-server 2>/dev/null 35 | 36 | Show pending APT updates count, optionally sorted : 37 | 38 | pussh -f servers -l root sh -c 'apt-get -qq update && apt-get -qsy dist-upgrade |grep -c ^Inst 2>/dev/null' | sort -rn -t: -k2 39 | 40 | -------------------------------------------------------------------------------- /TODO: -------------------------------------------------------------------------------- 1 | TODO: 2 | 3 | - output grouping (per host buffering until command is done) + optional sorting 4 | (different than pussh ...|sort since it keeps per host time ordered output) 5 | 6 | - limit number of simultaneous connections 7 | 8 | - don't fold host's stderr into stdout, eg: 9 | ( ( cmd | sed 's/^/out: /' ) 3>&1 1>&2 2>&3 ) | sed 's/^/err: /' 3>&1 1>&2 2>&3 10 | 11 | - gather command exit status, make some use (stats, etc) 12 | 13 | -------------------------------------------------------------------------------- /debian/README: -------------------------------------------------------------------------------- 1 | The Debian Package pussh 2 | ---------------------------- 3 | 4 | Comments regarding the Package 5 | 6 | -- Vincent CARON Sun, 19 May 2013 21:54:44 +0200 7 | -------------------------------------------------------------------------------- /debian/changelog: -------------------------------------------------------------------------------- 1 | pussh (1.0) unstable; urgency=low 2 | 3 | * Initial Release. 4 | 5 | -- Vincent CARON Sun, 19 May 2013 21:54:44 +0200 6 | -------------------------------------------------------------------------------- /debian/compat: -------------------------------------------------------------------------------- 1 | 8 2 | -------------------------------------------------------------------------------- /debian/control: -------------------------------------------------------------------------------- 1 | Source: pussh 2 | Section: admin 3 | Priority: extra 4 | Maintainer: Vincent CARON 5 | Build-Depends: debhelper (>= 8.0.0) 6 | Standards-Version: 3.9.3 7 | Homepage: https://github.com/bearstech/pussh 8 | #Vcs-Git: git://github.com/bearstech/pussh.git 9 | #Vcs-Browser: https://github.com/bearstech/pussh 10 | 11 | Package: pussh 12 | Architecture: all 13 | Depends: ${misc:Depends}, ssh-client 14 | Description: parallel ssh, run a shell snippet or a whole program quickly on many hosts 15 | pussh takes a host list and a shell snippet or a whole program, then run it in 16 | batch mode on all hosts and return their output. It adds facilities to pipe 17 | file or commands to every command's input and/or output. It is meant to be a 18 | natural extension to the SSH batch mode (eg.: in | sh "command args ..." | 19 | out), although having many inputs and outputs does not let you use pipes the 20 | same way; you will have to decide how to multiplex those inputs and outputs, 21 | which should hopefully be easy. 22 | -------------------------------------------------------------------------------- /debian/copyright: -------------------------------------------------------------------------------- 1 | Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 2 | Upstream-Name: pussh 3 | Source: 4 | 5 | Files: * 6 | Copyright: 2011-2013 Bearstech 7 | License: GPL-3.0+ 8 | 9 | Files: debian/* 10 | Copyright: 2011-2013 Bearstech 11 | License: GPL-3.0+ 12 | 13 | License: GPL-3.0+ 14 | This program is free software: you can redistribute it and/or modify 15 | it under the terms of the GNU General Public License as published by 16 | the Free Software Foundation, either version 3 of the License, or 17 | (at your option) any later version. 18 | . 19 | This package is distributed in the hope that it will be useful, 20 | but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | GNU General Public License for more details. 23 | . 24 | You should have received a copy of the GNU General Public License 25 | along with this program. If not, see . 26 | . 27 | On Debian systems, the complete text of the GNU General 28 | Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". 29 | -------------------------------------------------------------------------------- /debian/docs: -------------------------------------------------------------------------------- 1 | NEWS 2 | README.md 3 | RECIPES.md 4 | TODO 5 | -------------------------------------------------------------------------------- /debian/rules: -------------------------------------------------------------------------------- 1 | #!/usr/bin/make -f 2 | # -*- makefile -*- 3 | 4 | # Uncomment this to turn on verbose mode. 5 | #export DH_VERBOSE=1 6 | 7 | %: 8 | dh $@ 9 | 10 | # Skip the tests, we can't login into the local sshd in pbuilder 11 | override_dh_auto_test: 12 | -------------------------------------------------------------------------------- /debian/source/format: -------------------------------------------------------------------------------- 1 | 3.0 (native) 2 | -------------------------------------------------------------------------------- /pussh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # pussh - run commands thru ssh on hundreds of server 4 | # Copyright (C) 2011-2024 Bearstech - http://bearstech.com 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | set -e 20 | 21 | THIS_NAME=pussh 22 | THIS_VERSION=1.4 23 | 24 | 25 | # Dependencies: 26 | # - bash (bashisms: arrays, string manipulation) 27 | # - coreutils thingies (cat, dd, stat) 28 | # - grep 29 | # - sed 30 | # - ssh client (duh) 31 | 32 | help() { 33 | cat < connect to hosts listed in file, one per line. 38 | Special file '-' may be used for stdin 39 | -h, --hosts connect to hosts. Several -h options may be used, 40 | syntax [login@]host[:port] is accepted 41 | -i, --input feed a file (%h to split by host, -i in/%h.txt) 42 | or a command to remote stdin (-i 'tar -czC in/%h|') 43 | -l, --login remote login name; shortcut for -s '-l ' 44 | -n, --dry-run dry run: don't run commands, only print what would 45 | be done 46 | -o, --output output to a file (%h to split by host, -o %h.txt), 47 | or to a command (-o '|tar -xzC out/%h') 48 | -q, --quiet quiet: don't stamp (prefix) stdout and stderr, do 49 | not report total hosts and time 50 | -r, --rate connect rate in new SSH conn/sec (default: 10) 51 | -s, --ssh-opt pass options to SSH, eg -s '-x -p 2022' 52 | -u, --upload upload the command file and run its copy remotely 53 | -4 force ssh to use IPv4 addresses only 54 | -6 force ssh to use IPv6 addresses only 55 | 56 | --help display this help and exit 57 | --version output version information and exit 58 | EOF 59 | } 60 | 61 | version() { 62 | echo "$THIS_NAME $THIS_VERSION" 63 | } 64 | 65 | error() { 66 | echo "$THIS_NAME error: $*" >&2 67 | exit 1 68 | } 69 | 70 | 71 | # Options 72 | dryrun= 73 | hosts= 74 | input= 75 | output= 76 | upload= 77 | quiet= 78 | rate=10 79 | sshopts= 80 | 81 | parse_opt='run' 82 | while [ -n "$parse_opt" ] ; do 83 | case "$1" in 84 | 85 | -f|--from-file) shift; hosts="$hosts $(grep -vE '^[ ]*(#|$)' "$1")";; 86 | -h|--hosts) shift; hosts="$hosts ${1//,/ }";; 87 | -i|--input) shift; input="$1";; 88 | -l|--login) shift; sshopts="$sshopts -l$1";; 89 | -n|--dry-run) dryrun=yes;; 90 | -o|--output) shift; output="$1";; 91 | -q|--quiet) quiet=yes;; 92 | -r|--rate) shift; rate="$1";; 93 | -s|--ssh-opt) shift; sshopts="$sshopts $1";; 94 | -u|--upload) upload=yes;; 95 | -4) sshopts="$sshopts -4";; 96 | -6) sshopts="$sshopts -6";; 97 | 98 | --help) help; exit 0;; 99 | --version) version; exit 0;; 100 | 101 | --) parse_opt=; shift; break;; 102 | -*) error "unknown option '$1'";; 103 | *) parse_opt=; break;; 104 | esac 105 | shift 106 | done 107 | 108 | # Make sure we have something to do 109 | # 110 | if [ $# = 0 ]; then 111 | error "missing command, nothing to do" 112 | fi 113 | 114 | # In upload mode, we try to test the program availability early rather than 115 | # fail later on all remote hosts. The best test is to actually open and read 116 | # it. 117 | if [ -n "$upload" ]; then 118 | pname="$1" 119 | shift 120 | perr=$(cat "$pname" 2>&1 >/dev/null) 121 | if [ -n "$perr" ]; then 122 | error "$perr" 123 | fi 124 | 125 | # We'll need the program size to transfer it as "SSH shell session preamble" 126 | # (see below). 127 | plen=$(stat -c%s "$pname") 128 | ptmp=/tmp/remote-${pname##*/}-$$ 129 | fi 130 | 131 | # Compute sleep period from connection rate (we strive to avoid 'bc') 132 | # 133 | if [ "$rate" -gt 0 ]; then 134 | delay=$(printf ".%03d" $((1000 / rate))) 135 | fi 136 | 137 | # Count hosts and compute their maximal print width for pretty printing 138 | # 139 | nhost=0 140 | width=0 141 | for hostspec in $hosts; do 142 | host="${hostspec##*@}" 143 | host="${host%%:*}" 144 | nhost=$((nhost + 1)) 145 | width=$((${#host} > width ? ${#host} : width)) 146 | if [ -n "$dryrun" ]; then 147 | echo "[test] $host" 148 | fi 149 | done 150 | if [ $nhost = 0 ]; then 151 | error "no hosts, either specify hosts with -h or -f" 152 | fi 153 | if [ -n "$dryrun" ]; then 154 | echo "Total: $nhost hosts(s)" >&2 155 | exit 0 156 | fi 157 | export width 158 | 159 | 160 | # Input methods 161 | # 162 | 163 | input_null() { 164 | exec <&- 165 | } 166 | 167 | input_file() { 168 | case "$input" in 169 | *%h*) infile="${input//\%h/$host}";; 170 | *) infile="$input";; 171 | esac 172 | exec cat "$infile" 173 | } 174 | 175 | input_cmd() { 176 | case "$input" in 177 | *%h*) incmd="${input//\%h/$host}";; 178 | *) incmd="$input";; 179 | esac 180 | eval "${incmd::${#incmd}-1}" 181 | } 182 | 183 | export input 184 | case "$input" in 185 | "") incmd=input_null;; 186 | *\|) incmd=input_cmd;; 187 | *) incmd=input_file;; 188 | esac 189 | 190 | 191 | # Output methods 192 | # 193 | 194 | declare -A stamp 195 | 196 | output_stamp() { 197 | # In silence mode, use 'cat' passthru 198 | if [ -n "$quiet" ]; then 199 | cat 200 | exit 0 201 | fi 202 | 203 | # Otherwise compute $stamp and use 'sed' to prefix every line 204 | s=${stamp["$host"]} 205 | if [ -z "$s" ]; then 206 | s=$(printf "%-${width}s: " "$host") 207 | stamp["$host"]="$s" 208 | fi 209 | sed -e "s/^/$s/" 210 | } 211 | 212 | # FIXME: this is probably buggy to use one 'cat >>' per SSH session when 213 | # outputting to a single file, output merges in a single file from multiple 214 | # processes are unpredictable and not necessarily aligned at the line 215 | # boundary. It just looks like it happens to work with 130 hosts (in ~20sec), 216 | # we'll see. 217 | output_file() { 218 | case "$output" in 219 | *%h*) outfile="${output//\%h/$host}"; per_host=1;; 220 | *) outfile="$output"; started=$output_started; export output_started=1;; 221 | esac 222 | 223 | # Be cool, create folder(s) if necessary 224 | outpath=${outfile%/*} 225 | if [ "$outpath" != "$outfile" ]; then 226 | mkdir -p "$outpath" 227 | fi 228 | 229 | if [ -n "$per_host" ] || [ -z "$started" ]; then 230 | cat >"$outfile" 231 | else 232 | cat >>"$outfile" 233 | fi 234 | } 235 | 236 | output_cmd() { 237 | case "$output" in 238 | *%h*) outcmd="${output//\%h/$host}";; 239 | *) outcmd="$output";; 240 | esac 241 | eval "${outcmd:1}" 242 | } 243 | 244 | export output 245 | case "$output" in 246 | "") outcmd=output_stamp;; 247 | \|*) outcmd=output_cmd;; 248 | *) outcmd=output_file;; 249 | esac 250 | 251 | # Command line args re-quote - you don't want to know this shell ugliness. 252 | # But it is important to know that SSH on the server side will _always_ 253 | # exec the remote command thru the login shell, thus args are 'expanded'. 254 | # (thanks to http://blogs.gentoo.org/agriffis/2006/02/07/requoting_in_bash) 255 | argv= 256 | for a in "$@"; do 257 | qa=$(printf %q "$a") 258 | argv="$argv $qa" 259 | done 260 | 261 | t0=$SECONDS 262 | 263 | for hostspec in $hosts; do 264 | # $hostspec is '[root@]foo[:port]', extract loginhost/host/port 265 | loginhost="${hostspec%%:*}" 266 | host="${loginhost##*@}" 267 | port="${hostspec##*:}" 268 | 269 | # Add ssh's "-p " option if needed 270 | _sshopts="$sshopts" 271 | if [ "$port" != "" ] && [ "$port" != "$hostspec" ]; then 272 | _sshopts="$sshopts -p $port" 273 | fi 274 | 275 | export host 276 | ( 277 | # We use the same SSH connection to: 278 | # 1. transfer the script (hence dd...count=$scriptlen) 279 | # 2. then run the script, with closed stdin 280 | # 3. cleanup the remote end 281 | if [ -n "$upload" ]; then 282 | # shellcheck disable=SC2086,SC2029,SC2086 283 | ( cat "$pname"; $incmd ) | \ 284 | ssh $_sshopts "$loginhost" \ 285 | "dd of=\"$ptmp\" bs=1 count=$plen 2>/dev/null && chmod +x $ptmp && $ptmp $argv; e=\$?; rm $ptmp; exit \$e" \ 286 | 2>&1 | $outcmd 287 | else 288 | # shellcheck disable=SC2029,SC2086 289 | $incmd | \ 290 | ssh $_sshopts "$loginhost" \ 291 | "$argv" \ 292 | 2>&1 | $outcmd 293 | fi 294 | ) & 295 | # We need to throttle a bit otherwise the local ssh-agent fails 296 | sleep "$delay" 297 | done 298 | 299 | wait 300 | 301 | if [ -z "$quiet" ]; then 302 | dt=$((SECONDS - t0)) 303 | echo "Total: $nhost host(s), $dt second(s)" >&2 304 | fi 305 | -------------------------------------------------------------------------------- /pussh.1: -------------------------------------------------------------------------------- 1 | .\" Yes, this man page is handcrafted. 2 | .TH TR "1" "Apr 2024" "pussh" "User Commands" 3 | 4 | .SH NAME 5 | pussh \- parallel ssh, run a shell snippet or a whole program quickly on many hosts 6 | 7 | .SH SYNOPSIS 8 | .B pussh 9 | [\fIOPTION\fR]... \fICOMMAND \fR[\fIARGS\fR]... 10 | 11 | .SH DESCRIPTION 12 | .PP 13 | pussh takes a host list and a shell snippet or a whole program, then run it in 14 | batch mode on all hosts and return their output. It adds facilities to pipe 15 | file or commands to every command's input and/or output. It is meant to be a 16 | natural extension to the SSH batch mode (eg.: in | sh "command args ..." | 17 | out), although having many inputs and outputs does not let you use pipes the 18 | same way; you will have to decide how to multiplex those inputs and outputs, 19 | which should hopefully be easy. 20 | 21 | .SH OPTIONS 22 | .TP 23 | \fB-f\fR, \fB--from-file\fR FILE 24 | connect to hosts listed in FILE, one per line. Special file '-' may be used 25 | for stdin. Empty lines or lines starting with a dash (#) are ignored. 26 | .TP 27 | \fB-h\fR, \fB--hosts\fR HOST,... 28 | connect to thosse hosts. Several -h options may be used. Every host can be 29 | specified as [login@]host[:port]. 30 | .TP 31 | \fB-i\fR, \fB--input\fR INPUT 32 | feed a file (%h to split by host, -i in/%h.txt) or a command to remote stdin 33 | (-i 'tar -czC in/%h|') 34 | .TP 35 | \fB-l\fR, \fB--login\fR USER 36 | remote login name; shortcut for -s '-l USER' 37 | .TP 38 | \fB-n\fR, \fB--dry-run\fR 39 | dry run: don't run commands, only print what would be done 40 | .TP 41 | \fB-o\fR, \fB--output\fR OUTPUT 42 | output to a file (%h to split by host, -o out/%h.txt), or to a command 43 | (-o '|tar -xzC out/%h') 44 | .TP 45 | \fB-q\fR, \fB--quiet\fR 46 | quiet: don't stamp (prefix) stdout and stderr, do not report total hosts and 47 | time 48 | .TP 49 | \fB-r\fR, \fB--rate\fR RATE 50 | connect rate in new SSH connections/sec (default: 10) 51 | .TP 52 | \fB-s\fR, \fB--ssh-opt\fR OPTIONS 53 | pass OPTIONS to SSH, eg. -s '-x -p 2022' 54 | .TP 55 | \fB-u\fR, \fB--upload\fR 56 | upload the command file and run its copy remotely 57 | .TP 58 | \fB--help\fR 59 | display this help and exit 60 | .TP 61 | \fB--version\fR 62 | output version information and exit 63 | .PP 64 | You may use the SSH syntax \fBlogin@host\fR for HOST within \fB--from-file\fR and \fB--hosts\fR options to specify a different login for each host. This will override the \fB--login\fR option if given. 65 | 66 | .SH EXAMPLES 67 | .PP 68 | Show all servers rootfs usage in descending order : 69 | .IP 70 | pussh -f servers df -h / |grep /dev |sort -rn -k5 71 | .PP 72 | Count the number of processors in a cluster : 73 | .IP 74 | pussh -f servers grep ^processor /proc/cpuinfo |wc -l 75 | .PP 76 | Show the processor models, sorted by occurrence : 77 | .IP 78 | pussh -f servers sed -ne "s/^model name.*: //p" /proc/cpuinfo |sort |uniq -c 79 | .PP 80 | Fetch a list of installed package in one file per host : 81 | .IP 82 | pussh -f servers -o packages-for-%h dpkg --get-selections 83 | .PP 84 | Mass copy a file tree (broadcast) : 85 | .IP 86 | tar czf files.tar.gz ... && pussh -f servers -i files.tar.gz tar -xzC /to/dest 87 | .PP 88 | Mass copy several remote file trees (gather) : 89 | .IP 90 | pussh -f servers -o '|(mkdir -p %h && tar -xzC %h)' tar -czC /src/path . 91 | 92 | .SH AUTHOR 93 | Written by Vincent Caron . 94 | 95 | .SH "REPORTING BUGS" 96 | Report pussh bugs via https://github.com/bearstech/pussh/issues 97 | 98 | .SH COPYRIGHT 99 | Copyright \(co 2011-2024 Bearstech 100 | License GPLv3+: GNU GPL version 3 or later . 101 | .br 102 | This is free software: you are free to change and redistribute it. 103 | There is NO WARRANTY, to the extent permitted by law. 104 | 105 | .SH "SEE ALSO" 106 | The project home page at https://github.com/bearstech/pussh 107 | -------------------------------------------------------------------------------- /test: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Copyright (C) 2011-2024 Bearstech - http://bearstech.com 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | 18 | # This is a trivial test harness : command to run, expected exit status, 19 | # expected stdout (extended regex), expected stderr (extended regex), and 20 | # a custom optional test (a shell fragment). 21 | # 22 | # Only non-empty fields are checked. 23 | # 24 | # Use .test-* files for input, they will be cleaned up for you. 25 | # 26 | assert() { 27 | cmd="$1" 28 | ex="$2" 29 | out="$3" 30 | err="$4" 31 | more="$5" 32 | 33 | eval "$cmd" >.test-stdout 2>.test-stderr 34 | status=$? 35 | _failed=$failed 36 | 37 | if [ -n "$ex" -a "$ex" -ne $status ]; then 38 | echo "FAIL: $cmd: expected status $ex, got $status" 39 | let failed=$failed+1 40 | fi 41 | 42 | if [ -n "$out" ] && ! grep -qE "$out" .test-stdout; then 43 | echo "FAIL: $cmd: expected '$out' in stdout" 44 | let failed=$failed+1 45 | fi 46 | 47 | if [ -n "$err" ] && ! grep -qE "$err" .test-stderr; then 48 | echo "FAIL: $cmd: expected '$err' in stdout" 49 | let failed=$failed+1 50 | fi 51 | 52 | if [ -n "$more" ] && ! eval "$more"; then 53 | echo "FAIL: $cmd: '$more' custom test failed" 54 | let failed=$failed+1 55 | fi 56 | 57 | if [ $opt_stop = y -a $_failed != $failed ]; then 58 | exit $failed 59 | fi 60 | 61 | rm -f .test-* 62 | } 63 | 64 | pussh=./pussh 65 | 66 | opt_stop=n 67 | case "$1" in 68 | -s|--stop-on-error) opt_stop=y;; 69 | -*) echo "Usage: $0 [-s|--stop-on-errorl]" >&2; exit 1 70 | esac 71 | 72 | failed=0 73 | 74 | assert "$pussh" 1 '' 'missing command' 75 | assert "$pussh --help" 0 '^Usage:' 76 | assert "$pussh --version" 0 '^pussh [0-9]' 77 | 78 | # Basic usage (-h/--hosts, -q/--quiet) 79 | assert "$pussh -h localhost echo _TEST_" 0 '^localhost: _TEST_' 80 | assert "$pussh --hosts localhost echo _TEST_" 0 '^localhost: _TEST_' 81 | assert "$pussh -q -h localhost echo _TEST_" 0 '^_TEST_' 82 | assert "$pussh --quiet -h localhost echo _TEST_" 0 '^_TEST_' 83 | 84 | # -r/--rate 85 | assert "$pussh -q -h localhost -r 100 echo _TEST_" 0 '^_TEST_' 86 | assert "$pussh -q -h localhost --rate 100 echo _TEST_" 0 '^_TEST_' 87 | 88 | # -s/--ssh-opt 89 | assert "$pussh -q -h localhost -s '-p22' echo _TEST_" 0 '^_TEST_' 90 | assert "$pussh -q -h localhost --ssh-opt '-p22' echo _TEST_" 0 '^_TEST_' 91 | 92 | # -l/--login 93 | assert "$pussh -q -h localhost -l $LOGNAME echo _TEST_" 0 '^_TEST_' 94 | assert "$pussh -q -h localhost --login $LOGNAME echo _TEST_" 0 '^_TEST_' 95 | 96 | # -n/--dry-run 97 | assert "$pussh -q -h localhost -n echo _TEST_" 0 '^\[test\] localhost' 98 | assert "$pussh -q -h localhost --dry-run echo _TEST_" 0 '^\[test\] localhost' 99 | 100 | # -h/--hosts (multiple hosts) 101 | assert "$pussh -h localhost,127.0.0.1 echo _TEST_" 0 '^(localhost|127\.0\.0\.1): _TEST_' 102 | assert "$pussh -h localhost -h 127.0.0.1 echo _TEST_" 0 '^(localhost|127\.0\.0\.1): _TEST_' 103 | assert "$pussh -h $LOGNAME@localhost echo _TEST_" 0 '^localhost: _TEST_' 104 | assert "$pussh -h $LOGNAME@localhost:22 echo _TEST_" 0 '^localhost: _TEST_' 105 | assert "$pussh -h localhost:22 echo _TEST_" 0 '^localhost: _TEST_' 106 | 107 | # -f/--from-file 108 | assert "echo localhost | $pussh -q -f - echo _TEST_" 0 '^_TEST_' 109 | assert "echo localhost | $pussh -q --from-file - echo _TEST_" 0 '^_TEST_' 110 | echo "localhost 127.0.0.1" >.test-in 111 | assert "$pussh -f .test-in echo _TEST_" 0 '^(localhost|127\.0\.0\.1): _TEST_' 112 | echo -e "localhost\n#nowhere" >.test-in 113 | assert "$pussh -f .test-in echo _TEST_" 0 '^localhost: _TEST_' 114 | 115 | # -u/--upload 116 | assert "$pussh -q -h localhost -u /bin/echo arg1 arg2" 0 '^arg1 arg2' 117 | assert "$pussh -q -h localhost --upload /bin/echo arg1 arg2" 0 '^arg1 arg2' 118 | 119 | # -i/--input 120 | echo "_TEST_" >.test-in 121 | assert "$pussh -q -h localhost -i .test-in cat" 0 '^_TEST_' 122 | echo "_TEST_" >.test-in 123 | assert "$pussh -q -h localhost --input .test-in cat" 0 '^_TEST_' 124 | echo "_TEST_" >.test-in-localhost 125 | echo "_TEST_" >.test-in-127.0.0.1 126 | assert "$pussh -h localhost,127.0.0.1 -i .test-in-%h cat" 0 '^(localhost|127\.0\.0\.1): _TEST_' 127 | assert "$pussh -q -h localhost -i 'echo _TEST_|' cat" 0 '_TEST_' 128 | assert "$pussh -q -h localhost,127.0.0.1 -i 'echo %h= _TEST_|' cat" 0 '^(localhost|127\.0\.0\.1)= _TEST_' 129 | 130 | # -o/--output 131 | assert "$pussh -q -h localhost -o .test-out echo _TEST_" 0 '' '' 'grep -qE ^_TEST_ .test-out' 132 | assert "$pussh -q -h localhost --output .test-out echo _TEST_" 0 '' '' 'grep -qE ^_TEST_ .test-out' 133 | assert "$pussh -q -h localhost,127.0.0.1 -o .test-out-%h echo _TEST_" 0 '' '' \ 134 | 'grep -qE ^_TEST_ .test-out-localhost && grep -qE ^_TEST_ .test-out-127.0.0.1' 135 | assert "$pussh -q -h localhost -o '|cat >.test-out' echo _TEST_" 0 '' '' 'grep -qE ^_TEST_ .test-out' 136 | assert "$pussh -q -h localhost,127.0.0.1 -o '|cat >.test-out-%h' echo _TEST_" 0 '' '' \ 137 | 'grep -qE ^_TEST_ .test-out-localhost && grep -qE ^_TEST_ .test-out-127.0.0.1' 138 | 139 | exit $failed 140 | --------------------------------------------------------------------------------