Merge pull request #4945 from egmontkob/4896_skin_readme

4896 skin readme

Author: egmontkob

doc/man/mc.1.in

@@ -3649,9 +3649,8 @@ is used for popup menu title.
 .PP
 The possible colors are: black, gray, red, brightred, green,
 brightgreen, brown, yellow, blue, brightblue, magenta, brightmagenta,
-cyan, brightcyan, lightgray and white. And there is a special keyword
-for transparent background. It is 'default'. The 'default' can only be
-used for background color. Another special keyword "base" means mc's main
+cyan, brightcyan, lightgray and white; as well as "default" for the terminal's
+default foreground or background color. Another special keyword "base" means mc's main
 colors.  When 256 colors are available, they can be specified either as
 color16 to color255, or as rgb000 to rgb555 and gray0 to gray23. Example:
 .PP
@@ -3721,319 +3720,12 @@ or without it). Search of skin\-file will occur in (to the first one found):
 .br
 
 .PP
-For getting extended info, refer to:
-.IP
-.\"LINK2"
-Description of section and parameters
-.\"Skins sections"
-.br
-.\"LINK2"
-Color pair definitions
-.\"Skins colors"
-.br
-.\"LINK2"
-Color and attribute aliases
-.\"Skins aliases"
-.br
-.\"LINK2"
-Draw lines
-.\"Skins lines"
-.br
-.\"LINK2"
-Compatibility
-.\"Skins oldcolors"
-.br
-
-.\"NODE "  Skins sections"
-.SH "  Description of section and parameters"
-
-Section
-.B [skin]
-contain metainfo for skin\-file. Parameter
-.I description
-contain short text about skin.
-
-.PP
-Section
-.B [filehighlight]
-contain descriptions of color pairs for filenames highlighting.
-Name of parameters must be equal to names of sections into
-filehighlight.ini file.
-See
-.\"LINK2"
-Filenames Highlight
-.\"Filenames Highlight"
-for getting more info.
-
-.PP
-Section
-.B [core]
-describes the elements that are used everywhere.
-.TP
-.I _default_
-Default color pair. Used in all other sections if they not contain
-color definitions
-.TP
-.I selected
-cursor
-.TP
-.I marked
-selected data
-.TP
-.I markselect
-cursor on selected data
-.TP
-.I gauge
-color of the filled part of the progress bar
-.TP
-.I input
-color of input lines used in query dialogs
-.TP
-.I inputmark
-color of input selected text
-.TP
-.I inputunchanged
-color of input text before first modification or cursor movement
-.TP
-.I commandlinemark
-color of selected text in command line
-.TP
-.I reverse
-reverse color
-.PP
-Section
-.B [dialog]
-describes the elements that are placed on dialog windows (except error dialogs).
-.TP
-.I _default_
-Default color for this section. Used [core]._default_ if not specified
-.TP
-.I dfocus
-Color of active element (in focus)
-.TP
-.I dhotnormal
-Color of hotkeys
-.TP
-.I dhotfocus
-Color of hotkeys in focused element
-
-.PP
-Section
-.B [error]
-describes the elements that are placed on error dialog windows
-.TP
-.I _default_
-Default color for this section. Used [core]._default_ if not specified
-.TP
-.I errdhotnormal
-Color of hotkeys
-.TP
-.I errdhotfocus
-Color of hotkeys in focused element
-
-.PP
-Section
-.B [menu]
-describes the elements that are placed in menu. This section describes
-system menu (called by F9) and user\-defined menus (called by F2 in panels
-and by F11 in editor).
-.TP
-.I _default_
-Default color for this section. Used [core]._default_ if not specified
-.TP
-.I entry
-Color of menu items
-.TP
-.I menuhot
-Color of menu hotkeys
-.TP
-.I menusel
-Color of active menu item (in focus)
-.TP
-.I menuhotsel
-Color of menu hotkeys in focused menu item
-.TP
-.I menuinactive
-Color of inactive menu
-
-.PP
-Section
-.B [help]
-describes the elements that are placed on help window.
-.TP
-.I _default_
-Default color for this section. Used [core]._default_ if not specified
-.TP
-.I helpitalic
-Color pair for element with
-.B italic
-attribute
-.TP
-.I helpbold
-Color pair for element with
-.B bold
-attribute
-.TP
-.I helplink
-Color of links
-.TP
-.I helpslink
-Color of active link (on focus)
-
-.PP
-Section
-.B [editor]
-describes the colors of elements placed in editor.
-.TP
-.I _default_
-Default color for this section. Used [core]._default_ if not specified
-.TP
-.I editbold
-Color pair for element with
-.B bold
-attribute
-.TP
-.I editmarked
-Color of selected text
-.TP
-.I editwhitespace
-Color of tabs and trailing spaces highlighting
-.TP
-.I editlinestate
-Color for line state area
-
-.PP
-Section
-.B [viewer]
-describes the colors of elements placed in viewer.
-.TP
-.I viewunderline
-Color pair for element with
-.B underline
-attribute
-
-.\"NODE "  Skins colors"
-.SH "  Color pair definitions"
-Any parameter in skin\-file contain definition of color pair.
-.PP
-Color pairs described as two colors and the optional attributes
-separated by ';'. First field sets the foreground color, second
-field sets background color, third field sets the attributes.
-Any of the fields may be omitted, in this case value will be
-taken from default color pair (global color pair or from default
-color pair of this section).
-.PP
-Example:
-.br
-.nf
-[core]
-    # green on black
-    _default_=green;black
-    # green (default) on blue
-    selected=;blue
-    # yellow on black (default)
-    # underlined yellow on black (default)
-    marked=yellow;;underline
-.fi
+The format of skin files is described in
+.BR %pkgdatadir%/skins/README.txt .
 
-.PP
-Possible colors (names) and attributes are described in
-.\"LINK2"
-Colors\&.
-.\"Colors"
-section.
-
-.\"NODE "  Skins aliases"
-.SH "  Color and attribute aliases"
-This optional section might define aliases for single colors (not color pairs)
-as well as combination of attributes; in other words, for semicolon\-separated
-fragments of parameters. Aliases can refer to other aliases as long as they
-don't form a loop.
-.PP
-Example:
-.br
-.nf
-[aliases]
-    myfavfg=green
-    myfavbg=black
-    myfavattr=bold+italic
-[core]
-    _default_=myfavfg;myfavbg;myfavattr
-.fi
-
-.\"NODE "  Skins lines"
-.SH "  Draw lines"
-Lines sets in section
-.B [Lines]
-into skin\-file. By default single lines are used, but you may redefine
-to usage of any utf\-8 symbols (like to lines, for example).
-
-.PP
-Descriptions of parameters
-.BR [Lines] :
-.TP
-.I lefttop
-left\-top line fragment.
-.TP
-.I righttop
-right\-top line fragment.
-.TP
-.I centertop
-down branch of horizontal line
-.TP
-.I centerbottom
-up branch of horizontal line
-.TP
-.I leftbottom
-left\-bottom line fragment
-.TP
-.I rightbottom
-right\-bottom line fragment
-.TP
-.I leftmiddle
-right branch of vertical line
-.TP
-.I rightmiddle
-left branch of vertical line
-.TP
-.I centermiddle
-cross of lines
-.TP
-.I horiz
-horizontal line
-.TP
-.I vert
-vertical line
-.TP
-.I thinhoriz
-thin horizontal line
-.TP
-.I thinvert
-thin vertical line
-
-
-.\"NODE "  Skins oldcolors"
-.SH "  Compatibility"
-
-Appointment of color  by skin\-files fully compatible with
-the appointment of the colors described in
-.\"LINK2"
-Colors\&.
-.\"Colors"
-section.
-.PP
-In this case, reassignment of colors has priority over the skin file and is
-complementary.
-
-.\"NODE "Filenames Highlight"
 .SH "Filenames Highlight"
 Section [filehighlight] in current skin\-file contains key names as
-highlight groups and values as color pairs. Color pairs is documented
-in
-.\"LINK2"
-Skins
-.\"Skins"
-section.
+highlight groups and values as color pairs.
 .PP
 Rules of filenames highlight are placed in %pkgdatadir%/filehighlight.ini file
 (~/.config/mc/filehighlight.ini).

misc/skins/Makefile.am

@@ -1,6 +1,6 @@
 skindir = $(pkgdatadir)/skins
 
-skin_DATA = \
+SKINS = \
 	dark.ini \
 	darkfar.ini \
 	default.ini \
@@ -41,5 +41,9 @@ skin_DATA = \
 	yadt256-defbg.ini \
 	yadt256.ini
 
+skin_DATA = \
+	README.txt \
+	$(SKINS)
+
 EXTRA_DIST = \
-    $(skin_DATA)
+	$(skin_DATA)