multishell-1.1.10/ 0000755 0001752 0001753 00000000000 14247214776 012423 5 ustar elpa elpa multishell-1.1.10/getting-to-a-shell.md 0000644 0001752 0001753 00000003454 13761141475 016352 0 ustar elpa elpa Multishell enables you to get to the input prompt in the shell you want
with as few keystrokes as possible.
* One keybinding, unmodified, gets you to the your current default shell, if
not in a shell, or to the input prompt of the current shell, if you're in
one.
* Use the universal argument to select a specific shell buffer, wherever
point happens to be residing. Enter an empty line to the prompt to go to
your current default shell, or use completing read to go to a shell from
your multishell history, or start a new shell at the path you specify -
including remote paths, using tramp syntax. (See the
multishell-pop-to-shell docstring in [multishell.el](multishell.el) for
details.)
* Use a doubled universal argument to set the shell you choose to be the
current default. (The prompt will indicate that mode with a "<==".)
Here's the decision tree:
* No universal argument - use:
* From-buffer is shell buffer: use from-buffer current name/path
- if shell/connection is stopped, restart/reconnect
- if not at input prompt, go there
* From-buffer is not shell buffer:
- Go to multishell-primary-name current name/path, creating or
restarting and/or reconnecting if that shell is not currently running.
* Universal argument provided - use:
- No name is specified - use current multishell-primary-name path
* Name is specified - use named buffer (creating if not already present):
* Path is also specified:
- shell is running - ignore new path
- shell will be started or restarted - use new path
* No path is specified:
- Name has history: use path from history
- Name has no history: use path that target buffer already has or inherits
- If the universal argument is doubled, set the selected shell as the
default one, going forwards.
multishell-1.1.10/LICENSE 0000644 0001752 0001753 00000104461 13761141475 013431 0 ustar elpa elpa GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
{project} Copyright (C) {year} {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
multishell-1.1.10/multishell-pkg.el 0000644 0001752 0001753 00000000674 14247214776 015715 0 ustar elpa elpa ;; Generated package description from multishell.el -*- no-byte-compile: t -*-
(define-package "multishell" "1.1.10" "Organize use of multiple shell buffers, local and remote" '((cl-lib "0.5")) :commit "aa1433b8df6d950e8592c7e878922b4ec5374569" :authors '(("Ken Manheimer" . "ken.manheimer@gmail.com")) :maintainer '("Ken Manheimer" . "ken.manheimer@gmail.com") :keywords '("processes") :url "https://github.com/kenmanheimer/EmacsMultishell")
multishell-1.1.10/multishell-list.el 0000644 0001752 0001753 00000030637 13761141475 016104 0 ustar elpa elpa ;;; multishell-list.el --- tabulated-list-mode for multishell shell buffers -*- lexical-binding:t -*-
;; Copyright (C) 2016-2020 Free Software Foundation, Inc. and Ken Manheimer
;; Author: Ken Manheimer
;; Version: 1.1.8
;; Created: 2016 -- first public availability
;; Keywords: processes
;; URL: https://github.com/kenmanheimer/EmacsMultishell
;; See multishell.el for commentary, change log, etc.
(require 'tabulated-list)
(require 'multishell)
(eval-when-compile (require 'cl-lib))
(defgroup multishell-list nil
"Show a menu of all shell buffers in a buffer."
:group 'multishell)
(defface multishell-list-name
'((t (:weight bold)))
"Face for shell names in the Multishell List."
:group 'multishell-list)
(defun multishell-list-open-pop (&optional arg)
"Pop to current entry's shell in separate window.
The shell is started if it's not already going, unless this is
invoked with optional `universal-argument'. In that case we
pop to the buffer but don't change its run state."
(interactive "P")
(let ((list-buffer (current-buffer))
(entry (tabulated-list-get-id)))
(if arg
(pop-to-buffer
(multishell-bracket (multishell-name-from-entry entry)))
(multishell-list-dispatch-selected entry t))
(with-current-buffer list-buffer
(revert-buffer)
(multishell-list-goto-item-by-entry entry))))
(defun multishell-list-open-as-default ()
"Pop to current entry's shell, and set as the default shell."
(interactive)
(let ((list-buffer (current-buffer))
(entry (tabulated-list-get-id)))
(message "%s <==" (multishell-name-from-entry entry))
(multishell-list-dispatch-selected entry t t)
(with-current-buffer list-buffer
(revert-buffer)
(multishell-list-goto-item-by-entry entry))))
(defun multishell-list-open-here (&optional arg)
"Switch to current entry's shell buffer.
The shell is started if it's not already going, unless this is
invoked with optional `universal-argument'. In that case we
switch to the buffer but don't activate (or deactivate) it it."
(interactive "P")
(let* ((list-buffer (current-buffer))
(entry (tabulated-list-get-id)))
(if arg
(switch-to-buffer
(multishell-bracket (multishell-name-from-entry entry)))
(multishell-list-dispatch-selected entry nil))
(with-current-buffer list-buffer
(revert-buffer))))
(defun multishell-list-delete (&optional _arg)
"Remove current shell entry, and prompt for buffer-removal if present."
(interactive)
(let* ((entry (tabulated-list-get-id))
(name (multishell-name-from-entry entry))
(name-bracketed (multishell-bracket name))
(buffer (get-buffer name-bracketed)))
(when (multishell-delete-history-name name)
(and buffer
;; If the process is live, let shell-mode get confirmation:
(or (comint-check-proc (current-buffer))
(y-or-n-p (format "Kill buffer %s? " name-bracketed)))
(kill-buffer name-bracketed)))
(tabulated-list-delete-entry)))
(defun multishell-list-edit-entry (&optional arg)
"Edit the value of current shell entry.
Submitting the change will not launch the entry, unless this is
invoked with optional `universal-argument'. In the latter case,
submitting the entry will pop to the shell in a new window,
starting it if it's not already going."
(interactive "P")
(let* ((list-buffer (current-buffer))
(entry (tabulated-list-get-id))
(name (multishell-name-from-entry entry))
(revised (multishell-read-unbracketed-entry
(format "Edit shell spec for %s: " name)
entry
'no-record))
(revised-name (multishell-name-from-entry revised))
buffer)
(when (not (string= revised entry))
(multishell-replace-entry entry revised)
(when (and (not (string= name revised-name))
(setq buffer (get-buffer (multishell-bracket name))))
(with-current-buffer buffer
(rename-buffer (multishell-bracket revised-name)))))
(when arg
(multishell-list-dispatch-selected revised-name t))
(with-current-buffer list-buffer
(revert-buffer)
(multishell-list-goto-item-by-entry revised))))
(defun multishell-list-clone-entry (&optional arg)
"Create a new list entry, edited from the current one, ready to launch.
If you provide an optional `universal-argument', the new entry
will be launched when it's created.
The already existing original entry is left untouched."
(interactive "P")
(let* ((prototype (tabulated-list-get-id))
(name (multishell-name-from-entry prototype))
(new (multishell-read-unbracketed-entry
(format "Clone new shell spec from %s: " name)
prototype
'no-record))
(new-name (multishell-name-from-entry new))
(new-path (cadr (multishell-split-entry new))))
(when (not (string= new prototype))
(multishell-register-name-to-path new-name new-path)
(revert-buffer)
(multishell-list-goto-item-by-entry new)
(when arg
(multishell-list-dispatch-selected new-name t)))))
(defun multishell-list-mouse-select (event)
"Select the shell whose line is clicked."
(interactive "e")
(select-window (posn-window (event-end event)))
(let ((entry (tabulated-list-get-id (posn-point (event-end event)))))
(multishell-list-dispatch-selected entry nil)))
(defun multishell-list-dispatch-selected (entry pop &optional set-primary)
"Go to multishell ENTRY, popping to window if POP is non-nil.
Optional arg SET-PRIMARY non-nil sets `multishell-primary-name' to entry.
Provide for concluding minibuffer interaction if we're in completing mode."
(let ((set-primary-as-arg (and set-primary '(16))))
(if multishell-completing-read
;; In multishell completing-read, arrange to conclude minibuffer input:
(throw 'multishell-minibuffer-exit (list entry pop set-primary-as-arg))
(multishell-pop-to-shell set-primary-as-arg entry (not pop)))))
(defun multishell-list-placeholder (value default)
"Return VALUE if non-empty string, else DEFAULT."
(if (or (not value) (string= value ""))
default
value))
(defconst multishell-list-active-flag "+")
(defconst multishell-list-inactive-flag ".")
(defconst multishell-list-absent-flag "x")
(defun multishell-list-entries ()
"Generate multishell name/path-spec entries list for tabulated-list."
(let ((recency 0))
(mapcar #'(lambda (entry)
(setq recency (1+ recency))
(let* ((splat (multishell-split-entry entry))
(name (car splat))
(buffer (and name
(get-buffer
(multishell-bracket name))))
(status (cond ((not buffer)
multishell-list-absent-flag)
((comint-check-proc buffer)
multishell-list-active-flag)
(t multishell-list-inactive-flag)))
(rest (cadr splat))
(dir (and rest (or (file-remote-p rest 'localname)
rest)))
(hops (and dir
(file-remote-p rest 'localname)
(substring
rest 0 (- (length rest) (length dir))))))
(when (not name)
(setq name (multishell-name-from-entry entry)))
(list entry
(vector (format "%d" recency)
status
(multishell-list--decorate-name name)
(multishell-list-placeholder hops "-")
(multishell-list-placeholder dir "~")))))
(multishell-all-entries))))
(defun multishell-list-goto-item-by-entry (entry)
"Position at beginning of line of tabulated list item for ENTRY."
(goto-char (point-min))
(while (and (not (eobp))
(not (string= (tabulated-list-get-id) entry)))
(forward-line 1)))
(define-obsolete-function-alias 'multishell-collate-row-strings-as-numbers
#'multishell-list--collate-row-strings-as-numbers "multishell 1.1.6")
(defun multishell-list--collate-row-strings-as-numbers (a b)
(let ((a (aref (cadr a) 0))
(b (aref (cadr b) 0)))
(> (string-to-number a) (string-to-number b))))
(defun multishell-list--decorate-name (name)
(propertize name
'font-lock-face 'multishell-list-name
'mouse-face 'highlight))
(defvar multishell-list-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map tabulated-list-mode-map)
(define-key map (kbd "c") 'multishell-list-clone-entry)
(define-key map (kbd "d") 'multishell-list-delete)
(define-key map (kbd "\C-k") 'multishell-list-delete)
(define-key map (kbd "k") 'multishell-list-delete)
(define-key map (kbd "e") 'multishell-list-edit-entry)
(define-key map (kbd "o") 'multishell-list-open-pop)
(define-key map (kbd " ") 'multishell-list-open-pop)
(define-key map (kbd "O") 'multishell-list-open-as-default)
(define-key map (kbd "RET") 'multishell-list-open-here)
(define-key map [mouse-2] 'multishell-list-mouse-select)
(define-key map [follow-link] 'mouse-face)
map))
(define-derived-mode multishell-list-mode
tabulated-list-mode "Shells"
"Major mode for listing current and historically registered shells.
Initial sort is from most to least recently used:
- First active shells, flagged with `+' a plus sign
- Then, inactive shells, flagged with `.' a period
- Then historical shells that currently have no buffer, flagged with `x' an ex
\\{multishell-list-mode-map\}"
(setq tabulated-list-format
[;; (name width sort '(:right-align nil :pad-right nil))
("#" 0 multishell-list--collate-row-strings-as-numbers :pad-right 1)
("! " 1 t :pad-right 1)
("Name" 15 t)
("Hops" 30 t)
("Directory" 30 t)]
tabulated-list-sort-key '("#" . t)
tabulated-list-entries #'multishell-list-entries)
(tabulated-list-init-header))
(defun multishell-list-cull-dups (entries)
"Return list of multishell ENTRIES sans ones with duplicate names.
For duplicates, we prefer the ones that have paths."
(let ((tally (make-hash-table :test #'equal))
got name name-order-reversed already)
(dolist (entry entries)
(setq name (multishell-name-from-entry entry)
already (gethash name tally nil))
(when (not already)
(push name name-order-reversed))
(when (or (not already) (< (length already) (length entry)))
;; Add new or replace shorter prior entry for name:
(puthash name entry tally)))
(dolist (name name-order-reversed)
(push (gethash name tally) got))
got))
;;;###autoload
(defun multishell-list (&optional completing)
"Edit your current and historic list of shell buffers.
If optional COMPLETING is nil, we present the full
`multishell-history' list in a popped buffer named `*Shells*'.
In the buffer, hit ? or h for a list of commands.
When optional COMPLETING is non-nil, it must be a list of
multishell-history completion candidate entries, as provided by
`completing-read'. Then we present the list as a part of
minibuffer completion.
You can get to the shells listing by recursively invoking
\\[multishell-pop-to-shell] at the `multishell-pop-to-shell'
`universal-argument' prompts."
(interactive)
(let ((from-entry (car (multishell-history-entries
(multishell-unbracket (buffer-name
(current-buffer))))))
(buffer (get-buffer-create (if completing
"*Completions*"
"*Shells*"))))
(if completing
(set-buffer buffer)
(pop-to-buffer buffer))
(multishell-list-mode)
(cl-progv
;; Temporarily assign multishell-history only when completing:
(when completing '(multishell-history))
(when completing
(list (multishell-list-cull-dups (mapcar #'substring-no-properties
completing))))
(tabulated-list-print))
(when completing
)
(when from-entry
(multishell-list-goto-item-by-entry from-entry))))
(provide 'multishell-list)
;;; multishell-list.el ends here
multishell-1.1.10/multishell.el 0000644 0001752 0001753 00000107661 14247214775 015141 0 ustar elpa elpa ;;; multishell.el --- Organize use of multiple shell buffers, local and remote -*- lexical-binding:t -*-
;; Copyright (C) 1999-2020 Free Software Foundation, Inc. and Ken Manheimer
;; Author: Ken Manheimer
;; Version: 1.1.10
;; Created: 1999 -- first public availability
;; Keywords: processes
;; Package-Requires: ((cl-lib "0.5"))
;; URL: https://github.com/kenmanheimer/EmacsMultishell
;;
;;; Commentary:
;;
;; Easily use and navigate multiple shell buffers, including remote shells.
;; Fundamentally, multishell is the function `multishell-pop-to-shell' -
;; a la `pop-to-buffer' - plus a keybinding. Together, they enable you to:
;;
;; * Easily get to the input point from wherever you are in a shell buffer,
;; or to any of your shell buffers, from anywhere inside emacs.
;;
;; * Use universal arguments and name completion to launch a new or choose
;; among existing shell buffers, and change which is the current default.
;;
;; * Easily restart exited shells, or shells from emacs prior sessions.
;;
;; * Specify an initial path for the shell. By using Emacs tramp syntax you
;; can launch a sudo and/or remote shell.
;;
;; For example, specifying the following at the multishell buffer name
;; prompt will:
;;
;; * `#root/sudo:root@localhost:/etc` launch a shell in a buffer named
;; "*#root*" with a root shell starting in /etc.
;;
;; * `/ssh:example.net:` launch a shell buffer in your homedir on
;; example.net. The buffer will be named "*example.net*".
;;
;; * `#ex/ssh:example.net|sudo:root@example.net:/etc` launch a root
;; shell starting in /etc on example.net named "*#ex*".
;;
;; * `interior/ssh:gateway.corp.com|ssh:interior.corp.com:` via
;; gateway.corp.com launch a shell in your homedir on interior.corp.com.
;; The buffer will be named "*interior*". You could append a sudo hop,
;; and so on.
;;
;; * Thanks to tramp, file visits initiated in remote shell buffers will
;; seamlessly be on the hosts where the shells are running, in the auspices
;; of the account being used.
;;
;; * Manage your list of shells, current and past, as a collection.
;;
;; * Of course, emacs completion makes it easy to switch to an already
;; existing shell buffer, or one in your history roster, by name.
;;
;; See the `multishell-pop-to-shell' docstring for details.
;;
;; Customize-group `multishell' to select and activate a keybinding and set
;; various behaviors. Customize-group `savehist' to preserve buffer
;; names/paths across emacs restarts.
;;
;; Please use
;; [the multishell repository](https://github.com/kenmanheimer/EmacsMultishell)
;; issue tracker to report problems, suggestions, etc, and see that
;; repository for a bit more documentation.
;;
;; Change Log:
;;
;; * 2022-06-04 1.1.10 Ken Manheimer:
;; - Autoload customizations so customized multishell keybinding triggers
;; load of the package.
;; - Refine multishell features description.
;; * 2021-08-02 1.1.10 Ken Manheimer:
;; - Get basic multishell command-key customization working.
;; * 2020-10-30 1.1.9 Ken Manheimer:
;; - Require cl-lib when compiling for cl-letf macro.
;; * 2020-10-28 1.1.8 Ken Manheimer:
;; - Change back to having multishell-list require multishell,
;; rather than the other way around, and remove now unnecessary
;; new autoloads.
;; - Bump version for ELPA release.
;; * 2020-10-28 1.1.7 Ken Manheimer:
;; - Forward compatibility: 'cl-progv' rather than 'progv', resolves
;; multishell-list error in recent emacs versions.
;; - Incorporate gnu refinements (thanks!)
;; * 2016-06-27 1.1.6 Ken Manheimer (unreleased):
;; - When starting a remote shell, if cd fails to an inital remote
;; directory, try again without the cd.
;; * 2016-02-11 1.1.5 Ken Manheimer:
;; - Rectify multishell list sorting to preserve recentness
;; - Increment the actual multishell-version setting, neglected for 1.1.4.
;; * 2016-02-11 1.1.4 Ken Manheimer:
;; - hookup multishell-list as completion help buffer.
;; Mouse and keyboard selections from help listing properly exits
;; minibuffer.
;; * 2016-02-09 1.1.3 Ken Manheimer:
;; multishell-list:
;; - add some handy operations, like cloning new entry from existing
;; - add optional behaviors to existing operations for returning to
;; stopped shells without restarting them.
;; - solidify maintaining focus on current entry
;; - fix miscellaneous.
;; * 2016-01-31 1.1.2 Ken Manheimer:
;; - Settle puzzling instability of multishell-all-entries
;; - The accumulations was putting items going from more to less active
;; categories to be put at the end, not beginning.
;; - Also, using history for prompting changes history - implement
;; no-record option to avoid this when needed.
;; - Implement simple edit-in-place multishell-replace-entry and use in
;; multishell-list-edit-entry.
;; - Remove now unnecessary multishell-list-revert-buffer-kludge.
;; - Rectify byte compiler offenses, and other fixes - thanks to Stefan
;; Monnier for pointing out many of the corrections.
;; - Avoid directly calling tramp functions unnecessarily.
;; * 2016-01-30 1.1.1 Ken Manheimer:
;; - shake out initial multishell-list glitches:
;; - (Offer to) delete shell buffer, if present, when deleting entry.
;; - Set recency (numeric rank) as initial sort field
;; - Recompute list on most operations that affect the order, and try to
;; preserve stability. (Kludgy solution, needs work.)
;; - Set version to 1.1.1 - multishell-list addition should have been 1.1.0.
;; * 2016-01-30 1.0.9 Ken Manheimer:
;; - Add multishell-list for managing the collection of current and
;; history-registered shells: edit, delete, and switch/pop to entries.
;; Easy access by invoking `multishell-pop-to-shell' from in the
;; `multishell-pop-to-shell' universal arg prompts.
;; - Duplicate existing shell buffer names in completions, for distinction.
;; - Add paths to buffers started without one, when multishell history dir
;; tracking is enabled.
;; - Major code cleanup:
;; - Simplify multishell-start-shell-in-buffer, in particular using
;; shell function, rather than unnecessarily going underneath it.
;; - Establish multishell-name-from-entry as canonical name resolver.
;; - Fallback to eval-after-load in emacs versions that lack
;; with-eval-after-load (eg, emacs 23).
;; - save-match-data, where match-string is used
;; - resituate some helpers
;; * 2016-01-24 1.0.8 Ken Manheimer:
;; - Work around the shell/tramp mishandling of remote+sudo+homedir problem!
;; The work around is clean and simple, basically using high-level `cd'
;; API and not messing with the low-level default-directory setting.
;; (Turns out the problem was not in my local config. Good riddance to the
;; awkward failure handler!)
;; - Clean up code resolving the destination shell, starting to document the
;; decision tree in the process. See getting-to-a-shell.md in the
;; multishell repository, https://github.com/kenmanheimer/EmacsMultishell
;; - There may be some shake-out on resolving the destination shell, but
;; this release gets the fundamental functionality soundly in place.
;; * 2016-01-23 1.0.7 Ken Manheimer:
;; - Remove notes about tramp remote+sudo+homedir problem. Apparently it's
;; due to something in my local site configuration (happens with -q but
;; not -Q).
;; * 2016-01-22 1.0.6 Ken Manheimer:
;; - Add multishell-version function.
;; - Tweak commentary/comments/docstrings.
;; - Null old multishell-buffer-name-history var, if present.
;; * 2016-01-16 1.0.5 Ken Manheimer:
;; - History now includes paths, when designated.
;; - Actively track current directory in history entries that have a path.
;; Custom control: multishell-history-entry-tracks-current-directory
;; - Offer to remove shell's history entry when buffer is killed.
;; (Currently the only UI mechanism to remove history entries.)
;; - Fix - prevent duplicate entries for same name but different paths
;; - Fix - recognize and respect tramp path syntax to start in home dir
;; - Simplify history var name, migrate existing history if any from old name
;; * 2016-01-04 1.0.4 Ken Manheimer - Released to ELPA
;; * 2016-01-02 Ken Manheimer - working on this in public, but not yet released.
;;
;; TODO and Known Issues:
;;
;; * Add custom shell launch prep actions
;; - for, eg, port knocking, interface activations
;; - shell commands to execute when shell name or path matches a regexp
;; - list of (regexp, which - name, path, or both, command)
;; * Investigate whether we can recognize and provide for failed hops.
;; - Tramp doesn't provide useful reactions for any hop but the first
;; - Might be stuff we can do to detect and convey failures?
;; - Might be no recourse but to seek tramp changes.
;; * Try minibuffer field boundary at beginning of tramp path, to see whether
;; the field boundary magically enables tramp path completion.
;;; Code:
(require 'comint)
(require 'shell)
(require 'savehist)
(eval-when-compile (require 'cl-lib))
(defvar multishell-version "1.1.10")
(defun multishell-version (&optional here)
"Return string describing the loaded multishell version."
(interactive "P")
(let ((msg (concat "Multishell " multishell-version)))
(if here (insert msg)
(if (called-interactively-p 'interactive)
(message "%s" msg)
msg))))
;;;###autoload
(unless (fboundp 'multishell-pop-to-shell)
(defgroup multishell nil
"Allout extension that highlights outline structure graphically.
Customize `allout-widgets-auto-activation' to activate allout-widgets
with allout-mode."
:group 'shell))
;;;###autoload
(unless (fboundp 'multishell-pop-to-shell)
(defun multishell-command-key-setter (symbol value)
"Establish key binding, or do nothing if none selected."
symbol
(cond (value
(setq multishell-command-key value)
(global-set-key multishell-command-key 'multishell-pop-to-shell))
((and multishell-command-key
(equal (lookup-key (current-global-map)
multishell-command-key)
'multishell-pop-to-shell))
(global-unset-key multishell-command-key)
(setq multishell-command-key nil))))
)
;; For the package load to be triggered by a user's customized
;; multishell-command-key we have to autoload the customizations. That
;; requires a workaround like that described here, which I use:
;; https://stackoverflow.com/questions/32693757/emacs-package-customization-and-autoloads
;;;###autoload
(unless (fboundp 'multishell-pop-to-shell)
(defcustom multishell-command-key [M-space]
"Key to bind to `multishell-pop-to-shell`.
If you select None then the prior binding is removed.
\(In some windowing environments `M- ` (Meta-space) doesn't
work. A possibly appealing alternative is `M-`.)"
:set #'multishell-command-key-setter
:type '(choice
(const :tag "None" nil)
(key-sequence :tag "Key sequence"))))
;;;###autoload
(unless (fboundp 'multishell-pop-to-shell)
(defcustom multishell-pop-to-frame nil
"*If non-nil, jump to a frame already showing the shell, if another one is.
Otherwise, disregard already-open windows on the shell if they're
in another frame, and open a new window on the shell in the
current frame.
\(Use `pop-up-windows' to change multishell other-window vs
current-window behavior.)"
:type 'boolean))
;;;###autoload
(unless (fboundp 'multishell-pop-to-shell)
(defcustom multishell-history-entry-tracks-current-directory t
"Maintain shell's current directory in its multishell history entry.
When set, the history entry for shells started with explicit
paths will track the shell's current working directory.
If `savehist-save-minibuffer-history' is enabled, the current
working directory of shells will be conveyed between Emacs sessions."
:type 'boolean))
(defvar multishell-history nil
"Name/path entries, most recent first.")
;; Migrate the few pre 1.0.5 users to changed history var:
(when (and (not multishell-history)
(boundp 'multishell-buffer-name-history)
multishell-buffer-name-history)
(setq multishell-history multishell-buffer-name-history
multishell-buffer-name-history nil))
(defvar multishell-primary-name "*shell*"
"Default shell name for un-modified multishell-pop-to-shell buffer target.
This is set by `multishell-pop-to-shell' as the current default,
when invoked with doubled universal argument.
If you want the designated primary that you have at the end of
one emacs session to be resumed at the next, customize
`savehist-additional-variables' to include the
`multishell-primary-name'.")
(defvar multishell-completing-read nil
"Internal use, conveying whether or not we're in the midst of a multishell
completing-read.")
;; Multiple entries happen because completion also adds name to history.
(defun multishell-register-name-to-path (name path)
"Add or replace entry associating NAME with PATH in `multishell-history'.
If NAME already had a PATH and new PATH is empty, retain the prior one.
Promote added/changed entry to the front of the list."
;; Add or promote to the front, tracking path changes in the process.
(let* ((entries (multishell-history-entries name))
(path (or path "")))
(dolist (entry entries)
(when (string= path "")
;; Retain explicit established path.
(setq path (cadr (multishell-split-entry entry))))
(setq multishell-history (delete entry multishell-history)))
(setq multishell-history (push (concat name path)
multishell-history))))
(defun multishell-replace-entry (entry revised)
"Replace every instance of ENTRY in `multishell-history' with REVISED.
Revised entry is situated where former one was.
Returns non-nil iff any changes were made."
(let ((candidates multishell-history)
did-revisions)
(while (setq candidates (member entry candidates))
(setcar candidates revised)
(setq candidates (cdr candidates)
did-revisions t))
did-revisions))
(defun multishell-history-entries (name)
"Return `multishell-history' entry that starts with NAME, or nil if none."
(let (got)
(dolist (entry multishell-history)
(when (and (string-equal name (multishell-name-from-entry entry))
(not (member entry got)))
(push entry got)))
got))
;;;###autoload
(defun multishell-pop-to-shell (&optional arg name here)
"Easily navigate to and within multiple shell buffers, local and remote.
Use a single `universal-argument' (\\[universal-argument]) to launch and choose between
nalternate shell buffers, and a doubled universal argument to also set your
choice as the ongoing default. Append a path to a new shell name to launch
a shell in that directory, and use Emacs tramp syntax to launch a remote
shell. There is a shortcut to manage your list of current and
historical shells, collectively, using `multishell-list' - see below.
Customize-group `multishell' to set up a key binding and tweak behaviors.
Manage your collection of current and historical shells by
recursively invoking \\[multishell-pop-to-shell] at the `multishell-pop-to-shell'
universal argument prompts, eg:
\\[universal-argument] \\[multishell-pop-to-shell] \\[multishell-pop-to-shell]
\(That will be just a few keys if you do the above customization.)
Hit ? in the listing buffer for editing commands.
==== Basic operation:
- If the current buffer is in shell-mode then focus is moved to
the process input point.
\(Use a universal argument go to a different shell buffer
when already in a buffer that has a process - see below.)
- If not in a shell buffer, go to a window that is already
showing a shell buffer, if any.
In this case, the cursor is not moved to the process input
point. Repeating the command once you're in the buffer will
then move the cursor to the process input point.
We respect `pop-up-windows', so you can adjust it to set the
other-buffer/same-buffer behavior.
- Otherwise, start a new shell buffer, using the current
directory as the working directory.
If a buffer with the resulting name exists and its shell process
was disconnected or otherwise stopped, it's resumed.
===== Universal arg to start and select between named shell buffers:
You can assign a distinct name to new shell buffers by prefixing
your \\[multishell-pop-to-shell] invocation with a single or double
`universal-argument', \\[universal-argument]:
- With a single universal argument, prompt for the buffer name
to use (without the asterisks that shell mode will put around
the name), defaulting to `shell'.
Completion is available.
This combination makes it easy to start and switch across
multiple shell restarts.
- A double universal argument will prompt for the name and set
the default to that name, so the target shell becomes the
primary.
See `multishell-primary-name' for info about preserving the
setting across emacs restarts.
- Manage your collection of current and historical shells by
recursively invoking \\[multishell-pop-to-shell] at the `multishell-pop-to-shell'
universal argument prompts, or at any time via
\\[multishell-list]. Hit ? in the listing buffer for editing
commands.
===== Select starting directory and remote host:
The shell buffer name you give to the prompt for a universal arg
can include an appended path. That will be used for the startup
directory. You can use tramp remote syntax to specify a remote
shell. If there is an element after a final `/', that's used for
the buffer name. Otherwise, the host, domain, or path is used.
For example:
* `#root/sudo:root@localhost:/etc' for a buffer named \"*#root*\" with a
root shell starting in /etc.
* `/ssh:example.net:' for a shell buffer in your homedir on example.net.
The buffer will be named \"*example.net*\".
* `#ex/ssh:example.net|sudo:root@example.net:/var/log' for a root shell
starting in /var/log on example.net named \"*#ex*\".
* `interior/ssh:gateway.corp.com|ssh:interior.corp.com:' to go
via gateway.corp.com to your homedir on interior.corp.com. The
buffer will be named \"*interior*\". You could append a sudo
hop to the path, combining the previous example, and so on.
File visits from the shell, and many common emacs activities like
dired, will be on the host where the shell is running, in the
auspices of the target account, and relative to the current
directory.
You can change the startup path for a shell buffer by editing it
at the completion prompt. The new path will not take effect for
an already-running shell.
To remove a shell buffer's history entry, kill the buffer and
affirm removal of the entry when prompted.
===== Activate savehist to retain shell buffer names and paths across Emacs restarts:
To have emacs maintain your history of shell buffer names and paths,
customize the savehist group to activate savehist."
(interactive "P")
(let ((token '(token)))
(if (window-minibuffer-p)
(throw 'multishell-minibuffer-exit token)
(let ((got (catch 'multishell-minibuffer-exit
(multishell-pop-to-shell-worker arg name here))))
;; Handle catch or plain fall-through - see cond comments for protocol.
(cond
;; Caught token from recursive invocation in minibuffer:
((equal token got) (multishell-list))
;; Caught specifaction of multishell args, eg from multishell-list:
((listp got) (multishell-pop-to-shell-worker (nth 2 got)
(nth 0 got)
(nth 1 got)))
;; Regular fallthrough - just relay the result:
(t got))))))
(defun multishell-pop-to-shell-worker (&optional arg name here)
"Do real work of `multishell-pop-to-shell', which see."
(let* ((from-buffer (current-buffer))
(from-buffer-is-shell (derived-mode-p 'shell-mode))
(primary-name-unbracketed (multishell-unbracket
multishell-primary-name))
(fallthrough-name (if from-buffer-is-shell
(buffer-name from-buffer)
primary-name-unbracketed))
(doublearg (equal arg '(16)))
(target-name-and-path
(multishell-resolve-target-name-and-path
(cond (name name)
(arg
(or (multishell-read-unbracketed-entry
(format "Shell buffer name [%s]%s "
primary-name-unbracketed
(if doublearg " <==" ":")))
primary-name-unbracketed))
(t fallthrough-name))))
(use-path (cadr target-name-and-path))
(target-shell-buffer-name (car target-name-and-path))
(target-buffer (get-buffer target-shell-buffer-name))
(curr-buff-proc (get-buffer-process from-buffer))
inwin
already-there)
;; Register early so the entry is pushed to the front:
(multishell-register-name-to-path (multishell-unbracket
target-shell-buffer-name)
use-path)
(when doublearg
(setq multishell-primary-name target-shell-buffer-name))
;; Situate:
(cond
((and (or curr-buff-proc from-buffer-is-shell)
(not arg)
(eq from-buffer target-buffer)
(not (eq target-shell-buffer-name (buffer-name from-buffer))))
;; In a shell buffer, but not named - stay in buffer, but go to end.
(setq already-there t))
((string= (buffer-name) target-shell-buffer-name)
;; Already in the specified shell buffer:
(setq already-there t))
((or (not target-buffer)
(not (setq inwin
(multishell-get-visible-window-for-buffer target-buffer))))
;; No preexisting shell buffer, or not in a visible window:
(when (not (get-buffer target-shell-buffer-name))
(message "Creating new shell buffer '%s'" target-shell-buffer-name))
(if here
(switch-to-buffer target-shell-buffer-name)
(pop-to-buffer target-shell-buffer-name pop-up-windows)))
;; Buffer exists and already has a window - jump to it:
(t (if (and multishell-pop-to-frame
inwin
(not (equal (window-frame (selected-window))
(window-frame inwin))))
(select-frame-set-input-focus (window-frame inwin)))
(if (not (string= (buffer-name (current-buffer))
target-shell-buffer-name))
(if here
(switch-to-buffer target-shell-buffer-name)
(pop-to-buffer target-shell-buffer-name t)))))
;; We're in the buffer. Activate:
(if (not (comint-check-proc (current-buffer)))
(multishell-start-shell-in-buffer use-path))
;; If the destination buffer has a stopped process, resume it:
(let ((process (get-buffer-process (current-buffer))))
(if (and process (equal 'stop (process-status process)))
(continue-process process)))
(when (or already-there
(equal (current-buffer) from-buffer))
(goto-char (point-max))
(and (get-buffer-process from-buffer)
(goto-char (process-mark (get-buffer-process from-buffer)))))))
(defun multishell-delete-history-name (name &optional ask)
"Remove all multishell history entries for NAME.
if optional ask is non-nil (default nil), ask before each deletion.
Return the last entry deleted."
(let (got)
(dolist (entry (multishell-history-entries name) got)
(when (and entry
(or (not ask)
(y-or-n-p (format "Remove multishell history entry `%s'? "
entry))))
(setq got entry
multishell-history (delete entry multishell-history))))))
(defun multishell-kill-buffer-query-function ()
"Offer to remove multishell-history entry for buffer."
;; Removal choice is crucial, so users can, eg, kill a shell with huge
;; output backlog, while keeping the history entry to easily restart it.
;;
;; We use kill-buffer-query-functions instead of kill-buffer-hook because:
;;
;; 1. It enables the user to remove the history without actually killing a
;; running buffer, by not confirming the subsequent running-proc query.
;; 2. kill-buffer-hooks often fails to run when killing shell buffers!
;; It's probably due to failures in other hooks - beyond our control -
;; and anyway, I like the first reason well enough.
;; (Use condition-case to avoid inadvertant disruption of kill-buffer
;; activity. kill-buffer happens behind the scenes a whole lot.)
(condition-case err
(and (derived-mode-p 'shell-mode)
(multishell-delete-history-name
(multishell-unbracket (buffer-name))
t))
(error
(message "multishell-kill-buffer-query-function error: %s" err)))
t)
(add-hook 'kill-buffer-query-functions #'multishell-kill-buffer-query-function)
(defun multishell-get-visible-window-for-buffer (buffer)
"Return visible window containing buffer."
(catch 'got-a-vis
(walk-windows
(function (lambda (win)
(if (and (eq (window-buffer win) buffer)
(equal (frame-parameter
(selected-frame) 'display)
(frame-parameter
(window-frame win) 'display)))
(throw 'got-a-vis win))))
nil 'visible)
nil))
(defun multishell-all-entries (&optional active-duplicated)
"Return multishell history, with active buffers listed first.
Optional ACTIVE-DUPLICATED will return a copy of
`multishell-history' with unbracketed names of active buffers,
sans paths, appended to the list, so they have short and long
completions."
;; Reorder so active lead present lead historical entries:
(let (active-entries active-names present past splat name buffer)
(dolist (entry multishell-history)
(setq splat (multishell-split-entry entry)
name (car splat)
buffer (and name (get-buffer (multishell-bracket name))))
(if (buffer-live-p buffer)
(if (comint-check-proc buffer)
(setq active-entries (push entry active-entries)
active-names (push name active-names))
(setq present (push entry present)))
(setq past (push entry past))))
;; Reverse present and past lists
(setq multishell-history (append (reverse active-entries)
(reverse present)
(reverse past)))
(if active-duplicated
(append multishell-history active-names)
multishell-history)))
(defun multishell-read-unbracketed-entry (prompt &optional initial no-record)
"PROMPT for shell buffer name, sans asterisks.
Optional INITIAL is preliminary value to be edited.
Optional NO-RECORD prevents changes to `multishell-history'
across the activity.
Input and completion can include associated path, if any.
Return what's provided, if anything, else nil."
(let* ((was-multishell-history multishell-history)
(candidates (multishell-all-entries 'active-duplicated))
(multishell-completing-read t)
(got
;; Use `cl-letf' to dynamically bind multishell-list to
;; display-completion-list, so multishell-list is used when doing
;; minibuffer-completion-help.
(cl-letf (((symbol-function 'display-completion-list)
#'multishell-list))
(completing-read prompt
;; COLLECTION:
(reverse candidates)
;; PREDICATE:
nil
;; REQUIRE-MATCH:
'confirm
;; INITIAL-INPUT
initial
;; HIST:
'multishell-history))))
(when no-record
(setq multishell-history was-multishell-history))
(if (not (string= got ""))
got
nil)))
(defun multishell-resolve-target-name-and-path (shell-spec)
"Given name/tramp-style address shell spec, resolve buffer name and directory.
The name is the part of the string up to the first `/' slash, if
any. Missing pieces are filled in from remote path elements, if
any, and multishell history. Given a tramp-style remote address
and no name part, either the user@host is used for the buffer
name, if a user is specified, or just the host.
Return them as a list: (name path), with name asterisk-bracketed
and path nil if none is resolved."
(let* ((splat (multishell-split-entry (or shell-spec "")))
(path (cadr splat))
(name (or (car splat) (multishell-name-from-entry path))))
(when (not path)
;; Get path from history, if present.
(dolist (entry
(multishell-history-entries
(multishell-unbracket name)))
(when (or (not path) (string= path ""))
(setq path (cadr (multishell-split-entry entry))))))
(list (multishell-bracket name) path)))
(defun multishell-name-from-entry (entry)
"Derive a name for a shell buffer according to ENTRY."
(if (not entry)
(multishell-unbracket multishell-primary-name)
(let* ((splat (multishell-split-entry entry))
(name (car splat))
(path (cadr splat)))
(or name
(if (file-remote-p path)
(let ((host (file-remote-p path 'host))
(user (file-remote-p path 'user)))
(cond ((and host user)
(format "%s@%s" user host))
(host host)
(user user)
((system-name))))
(multishell-unbracket multishell-primary-name))))))
(declare-function tramp-dissect-file-name "tramp")
(declare-function tramp-cleanup-connection "tramp")
(defun multishell-start-shell-in-buffer (where)
"Start, restart, or continue a shell in current-buffer on WHERE.
If WHERE is remote and includes a directory, cd to that directory on the
remote host.
If cd fails to an included remote directory, try again without the cd."
(let* ((is-active (comint-check-proc (current-buffer))))
(when (and where (not is-active))
;; FIXME: file-remote-p does not imply Tramp.
;; Why do we need to do something special for Tramp here?
(when (and (derived-mode-p 'shell-mode) (file-remote-p where))
;; Returning to disconnected remote shell - do some tidying.
;; FIXME: Without this cleanup, occasionally restarting a disconnected
;; remote session, particularly one that includes sudo, results in
;; an untraceable "Args out of range" error. That never happens if
;; we precedeed connection attempts with this cleanup -
;; prophylactic.
(tramp-cleanup-connection
(tramp-dissect-file-name default-directory 'noexpand)
'keep-debug 'keep-password))
(if (not (file-remote-p where))
(cd where)
(message "Connecting to %s" where)
(condition-case err
(cd where)
;; "cd: No such directory found via CDPATH environment variable"
(error
(if (string=
(cadr err)
"No such directory found via CDPATH environment variable")
;; Try again without dir part of remote where:
(let* ((final-colon-at (string-match ":[^:]+$" where))
(sans-dir-path (substring where 0 (1+ final-colon-at)))
(dir-path (substring where (1+ final-colon-at))))
(message "Failed to cd to %s, trying again without..."
dir-path)
(sit-for .5)
(cd sans-dir-path))
(signal (car err) (cdr err)))))))
(shell (current-buffer))))
(defun multishell-homedir-shorthand-p (dirpath)
"t if dirpath is an unexpanded remote homedir spec."
;; Workaround to recognize tramp-style homedir shorthand, "...:" and "...:~".
(let ((localname (file-remote-p dirpath 'localname)))
(and localname
(or
;; No directory path and no connection to expand homedir:
(string= localname "")
;; Original path doesn't equal expanded homedir:
(save-match-data
(not (string-match (concat (regexp-quote localname) "/?$")
dirpath)))))))
;; (assert (multishell-homedir-shorthand-p "/ssh:myhost.net:")
;; (assert (not (multishell-homedir-shorthand-p "/home/klm")))
;; (assert (not (multishell-homedir-shorthand-p "/ssh:myhost.net:/home/me")))
(defun multishell-track-dirchange (name newpath)
"Change multishell history entry to track current directory."
(let* ((entries (multishell-history-entries name)))
(dolist (entry entries)
(let* ((name-path (multishell-split-entry entry))
(path (or (cadr name-path) "")))
(when path
(let* ((old-localname (or (file-remote-p path 'localname)
path))
(newentry
(if (multishell-homedir-shorthand-p path)
(concat entry newpath)
(replace-regexp-in-string (concat (regexp-quote
old-localname)
"$")
;; REPLACEMENT
newpath
;; STRING
entry
;; FIXEDCASE
t
;; LITERAL
t
)))
(membership (member entry multishell-history)))
(when membership
(setcar membership newentry))))))))
(defvar multishell-was-default-directory ()
"Provide for tracking directory changes.")
(make-variable-buffer-local 'multishell-was-default-directory)
(defun multishell-post-command-business ()
"Do multishell bookkeeping."
;; Update multishell-history with dir changes.
(condition-case err
(when (and multishell-history-entry-tracks-current-directory
(derived-mode-p 'shell-mode))
(let ((curdir (if (file-remote-p default-directory)
(file-remote-p default-directory 'localname)
default-directory)))
(when (not (string= curdir (or multishell-was-default-directory "")))
(multishell-track-dirchange (multishell-unbracket (buffer-name))
curdir))
(setq multishell-was-default-directory curdir)))
;; To avoid disruption as a pervasive hook function, swallow all errors:
(error
(message "multishell-post-command-business error: %s" err))))
(add-hook 'post-command-hook #'multishell-post-command-business)
(defun multishell-split-entry (entry)
"Given multishell name/path ENTRY, return the separated name and path pair.
Returns nil for empty parts, rather than the empty string."
(save-match-data
(string-match "^\\([^/]*\\)\\(/?.*\\)?" entry)
(let ((name (match-string 1 entry))
(path (match-string 2 entry)))
(and (string= name "") (setq name nil))
(and (string= path "") (setq path nil))
(list name path))))
(defun multishell-bracket (name)
"Return a copy of name, ensuring it has an asterisk at the beginning and end."
(if (not (string= (substring name 0 1) "*"))
(setq name (concat "*" name)))
(if (not (string= (substring name -1) "*"))
(setq name (concat name "*")))
name)
(defun multishell-unbracket (name)
"Return a copy of name, removing asterisks, if any, at beginning and end."
(if (string= (substring name 0 1) "*")
(setq name (substring name 1)))
(if (string= (substring name -1) "*")
(setq name (substring name 0 -1)))
name)
(provide 'multishell)
;;; multishell.el ends here
multishell-1.1.10/README.md 0000644 0001752 0001753 00000005423 14247214776 013706 0 ustar elpa elpa multishell.el
=============
Organize multiple local and remote Emacs shell buffers.
Multishell is available via Emacs package manager, [in ELPA](https://elpa.gnu.org/packages/multishell.html). Install "multishell" from the `M-x package-list-packages` listing.
I use almost as many emacs shell buffers as I do tabs in my browser
sessions. Multishell makes it easy to organize my use of them with distinct
names for each, tramp syntax for remote and / or sudo shells, a roster of
them all that can be saved between emacs sessions (preserving remote and
sudo specifications), and more. With a customizable master keybinding,
multishell makes it easy to:
* Get to the input point from wherever you are in a shell buffer,
or to any of your shell buffers, from anywhere inside emacs.
* Use universal arguments and name completion to launch a new or choose
among existing shell buffers, and change which is the current default.
* Easily restart exited shells, or shells from prior emacs sessions.
* Specify an initial path for the shell. By using Emacs tramp syntax you
can launch a sudo and/or remote shell.
For example, specifying the following at the multishell buffer name
prompt will:
* `#root/sudo:root@localhost:/etc` launch a shell in a buffer named
"*#root*" with a root shell starting in /etc.
* `/ssh:example.net:` launch a shell buffer in your homedir on
example.net. The buffer will be named "*example.net*".
* `#ex/ssh:example.net|sudo:root@example.net:/etc` launch a root
shell starting in /etc on example.net named "*#ex*".
* `interior/ssh:gateway.corp.com|ssh:interior.corp.com:` via
gateway.corp.com launch a shell in your homedir on interior.corp.com.
The buffer will be named "*interior*". You could append a sudo hop,
and so on.
* Thanks to tramp, file visits initiated in remote shell buffers will
seamlessly be on the hosts where the shells are running, in the auspices
of the account being used.
* Manage your list of shells, current and past, as a collection.
* Of course, emacs completion makes it easy to switch to an already
existing shell buffer, or one in your history roster, by name.
See the `multishell-pop-to-shell` docstring (in
[multishell.el](multishell.el)) for details, and
[getting-to-a-shell.md](getting-to-a-shell.md) for the nitty-gritty
decision tree that determines where the keybinding goes according to the
various conditions.
Customize-group `multishell' to select and activate a keybinding and set
various behaviors. Customize-group `savehist' to preserve buffer
names/paths across emacs restarts.
Please use
[the multishell repository](https://github.com/kenmanheimer/EmacsMultishell)
issue tracker to report problems, suggestions, etc.
See the [multishell.el](multishell.el) file commentary for a change log and
Todo list.