diff --git a/src/doc/screen.texinfo b/src/doc/screen.texinfo index 001169c..9f2aa7b 100644 --- a/src/doc/screen.texinfo +++ b/src/doc/screen.texinfo @@ -995,6 +995,28 @@ Removed, use @code{paste} instead. @xref{Registers}. Destroy the current window. @xref{Kill}. @item lastmsg Redisplay the last message. @xref{Last Message}. +@item layout new [@var{title}] +Create a layout. @xref{Layout} +@item layout remove [@var{n}|@var{title}] +Delete a layout. @xref{Layout} +@item layout next +Select the next layout. @xref{Layout} +@item layout prev +Select the previous layout. @xref{Layout} +@item layout select [@var{n}|@var{title}] +Jump to a layout. @xref{Layout} +@item layout show +List the available layouts. @xref{Layout} +@item layout title [@var{title}] +Show or set the title of a layout. @xref{Layout} +@item layout number [@var{n}] +Show or set the number of a layout. @xref{Layout} +@item layout attach [@var{title}|:last] +Show or set which layout to reattach to. @xref{Layout} +@item layout save [@var{n}|@var{title}] +Remember the organization of a layout. @xref{Layout} +@item layout autosave [@var{on}|@var{off}] +Show or set the status of layout saving. @xref{Layout} @item license Display licensing information. @xref{Startup}. @item lockscreen @@ -1807,6 +1829,7 @@ which can contain different windows. * Resize:: Grow or shrink a region * Caption:: Control the window's caption * Fit:: Resize a window to fit the region +* Layout:: Manage groups of regions @end menu @node Split, Focus, , Regions @@ -1898,7 +1921,7 @@ You can mix both forms by providing the string as an additional argument. @end deffn -@node Fit, , Caption, Regions +@node Fit, Layout, Caption, Regions @section Fit @kindex F @deffn Command fit @@ -1908,6 +1931,134 @@ command is needed because screen doesn't adapt the window size automatically if the window is displayed more than once. @end deffn +@node Layout, , Fit, Regions +@section Layout +@cindex layout +Using regions, and perhaps a large enough terminal, you can create +a more of a desktop feel to @code{screen}. By being able to split +regions horizontally or vertically, you can take advantage of the +lesser used spaces of your terminal. The catch to these splits has +been that they're not kept between screen detachments and reattachments. + +Layouts will help your organization of regions. You can create one +layout of four horizontal regions and then create a separate layout +of regions in a two by two array. The regions don't have to contain +the same windows. You can easily switch between layouts and keep +them between detachments and reattachments. + +Note that there are several subcommands to @code{layout}. + +@menu +* Layout New:: Create a layout. +* Layout Remove:: Delete a layout. +* Layout Next:: Select the next layout. +* Layout Prev:: Select the previous layout. +* Layout Select:: Jump to a layout. +* Layout Show:: List the available layouts. +* Layout Title:: Show or set the title of a layout. +* Layout Number:: Show or set the number of a layout. +* Layout Attach:: Show or set which layout to reattach to. +* Layout Save:: Remember the organization of a layout. +* Layout Autosave:: Show or set the status of layout saving. +@end menu + +@deffn Command layout @code{new} [title] +(none)@* +Create a new layout. The screen will change to one whole region +and be switched to the blank window. From here, you build the +regions and the windows they show as you desire. The new layout +will be numbered with the smallest available integer, starting +with zero. You can optionally give a title to your new layout. +Otherwise, it will have a default title of @code{layout}. You +can always change the title later by using the command +@code{layout title}. +@end deffn + +@deffn Command layout @code{remove} [n|title] +(none)@* +Remove, or in other words, delete the specified layout. Either +the number or the title can be specified. Without either +specification, @code{screen} will remove the current layout. + +Removing a layout does not affect your set windows or regions. +@end deffn + +@deffn Command layout @code{next} +(none)@* +Switch to the next layout available +@end deffn + +@deffn Command layout @code{prev} +(none)@* +Switch to the previous layout available +@end deffn + +@deffn Command layout @code{select} [n|title] +(none)@* +Select the desired layout. Either the number or the title can +be specified. Without either specification, @code{screen} will +prompt and ask which screen is desired. To see which layouts are +available, use the @code{layout show} command. +@end deffn + +@deffn Command layout @code{show} +(none)@* +List on the message line the number(s) and title(s) of the available +layout(s). The current layout is flagged. +@end deffn + +@deffn Command layout @code{title} [title] +(none)@* +Change or display the title of the current layout. A string given +will be used to name the layout. Without any options, the current +title and number is displayed on the message line. +@end deffn + +@deffn Command layout @code{number} [n] +(none)@* +Change or display the number of the current layout. An integer given +will be used to number the layout. Without any options, the current +number and title is displayed on the message line. +@end deffn + +@deffn Command layout @code{attach} [title|@code{:last}] +(none)@* +Change or display which layout to reattach back to. The default is +@code{:last}, which tells @code{screen} to reattach back to the last +used layout just before detachment. By supplying a title, You can +instruct @code{screen} to reattach to a particular layout regardless +which one was used at the time of detachment. Without any options, +the layout to reattach to will be shown in the message line. +@end deffn + +@deffn Command layout @code{save} [n|title] +(none)@* +Remember the current arrangement of regions. When used, @code{screen} +will remember the arrangement of vertically and horizontally split +regions. This arrangement is restored when a @code{screen} session +is reattached or switched back from a different layout. If a number +or title is supplied, @code{screen} will remember the arrangement of +that particular layout. Without any options, @code{screen} will +remember the current layout. + +Saving your regions can be done automatically by using the +@code{layout autosave} command. +@end deffn + +@deffn Command layout @code{autosave} [@code{on}|@code{off}] +(none)@* +Change or display the status of automatcally saving layouts. The +default is @code{on}, meaning when @code{screen} is detached or +changed to a different layout, the arrangement of regions and windows +will be remembered at the time of change and restored upon return. +If autosave is set to @code{off}, that arrangement will only be +restored to either to the last manual save, using @code{layout save}, +or to when the layout was first created, to a single region with +a single window. Without either an @code{on} or an @code{off}, the +current status is displayed on the message line. +@end deffn + + @node Window Settings, Virtual Terminal, Regions, Top @chapter Window Settings