mirrors/mc
1
0
Fork 0
mirror of https://github.com/MidnightCommander/mc synced 2024-12-22 20:36:50 +03:00
Code Issues Packages Projects Releases Wiki Activity

Ticket #4224: add mcdiff manual page.

Browse Source 
Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
Signed-off-by: Andrew Borodin <aborodin@vmail.ru>
This commit is contained in:
Denys Vlasenko 2021-03-29 03:41:03 +02:00 committed by Andrew Borodin
parent 6b44fce839
commit 4092ea8bbe
3 changed files with 104 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/man/Makefile.am
View File

@ -3,7 +3,7 @@ if USE_NLS
SUBDIRS = $(DOC_LINGUAS)
endif
man_MANS = mc.1 mcedit.1 mcview.1
man_MANS = mc.1 mcedit.1 mcview.1 mcdiff.1
CLEANFILES = $(man_MANS)
@ -11,7 +11,8 @@ EXTRA_DIST = \
date-of-man-include.am \
mc.1.in \
mcedit.1.in \
mcview.1.in
mcview.1.in \
mcdiff.1.in
DATE_LANG=en_US.UTF-8
DATE_FORMAT=%B %Y

4
doc/man/date-of-man-include.am
View File

@ -15,6 +15,10 @@ mc.1: $(srcdir)/mc.1.in
MAN_FILE='$(srcdir)/mc.1.in'; MAN_DATE=$$($(MAN_DATE_CMD)); \
$(SED) $(SED_PARAMETERS) '$(srcdir)/mc.1.in' > '$@'
mcdiff.1: $(srcdir)/mcdiff.1.in
MAN_FILE='$(srcdir)/mcdiff.1.in'; MAN_DATE=$$($(MAN_DATE_CMD)); \
$(SED) $(SED_PARAMETERS) '$(srcdir)/mcdiff.1.in' > '$@'
mcedit.1: $(srcdir)/mcedit.1.in
MAN_FILE='$(srcdir)/mcedit.1.in'; MAN_DATE=$$($(MAN_DATE_CMD)); \
$(SED) $(SED_PARAMETERS) '$(srcdir)/mcedit.1.in' > '$@'

97
doc/man/mcdiff.1.in Normal file
View File

@ -0,0 +1,97 @@
.TH MCDIFF 1 "%DATE_OF_MAN_PAGE%" "MC Version %MAN_VERSION%" "GNU Midnight Commander"
.SH NAME
mcdiff \- Internal diff viewer of GNU Midnight Commander.
.SH USAGE
.B mcdiff
[\-bcCdfhstVx?] file1 file2
.SH DESCRIPTION
.LP
mcdiff is a link to
.BR mc ,
the main GNU Midnight Commander executable. Executing GNU Midnight
Commander under this name requests starting the internal diff viewer
which compares
.I file1
and
.I file2
specified on the command line.
.SH OPTIONS
.TP
.I "\-b"
Force black and white display.
.TP
.I "\-c"
Force color mode on terminals where
.B mcdiff
defaults to black and white.
.TP
.I "\-C <keyword>=<fgcolor>,<bgcolor>,<attributes>:<keyword>= ..."
Specify a different color set. See the
.B Colors
section in mc(1) for more information.
.TP
.I "\-d"
Disable mouse support.
.TP
.I "\-f"
Display the compiled\-in search paths for Midnight Commander files.
.TP
.I "\-t"
Used only if the code was compiled with S\-Lang and terminfo: it makes
the Midnight Commander use the value of the
.B TERMCAP
variable for the terminal information instead of the information on
the system wide terminal database
.TP
.I "\-V"
Displays the version of the program.
.TP
.I "\-x"
Forces xterm mode. Used when running on xterm\-capable terminals (two
screen modes, and able to send mouse escape sequences).
.PP
.SH COLORS
The default colors may be changed by appending to the
.B MC_COLOR_TABLE
environment variable. Foreground and background colors pairs may be
specified for example with:
.PP
.nf
MC_COLOR_TABLE="$MC_COLOR_TABLE:\\
normal=lightgray,black:\\
selected=black,green"
.fi
.PP
.SH FILES
.I %pkgdatadir%/mc.hlp
.IP
The help file for the program.
.PP
.I %pkgdatadir%/mc.ini
.IP
The default system\-wide setup for GNU Midnight Commander, used only if
the user's own ~/.config/mc/ini file is missing.
.PP
.I %pkgdatadir%/mc.lib
.IP
Global settings for the Midnight Commander. Settings in this file
affect all users, whether they have ~/.config/mc/ini or not.
.PP
.I ~/.config/mc/ini
.IP
User's own setup. If this file is present, the setup is loaded from
here instead of the system\-wide startup file.
.PP
.SH LICENSE
This program is distributed under the terms of the GNU General Public
License as published by the Free Software Foundation. See the built\-in
help of the Midnight Commander for details on the License and the lack
of warranty.
.SH AVAILABILITY
The latest version of this program can be found at
http://ftp.midnight\-commander.org/.
.SH SEE ALSO
mc(1), mcedit(1), mcview(1)
.PP
.SH BUGS
Bugs should be reported to https://www.midnight\-commander.org/.