diff options
| -rw-r--r-- | runtime/doc/Makefile | 8 | ||||
| -rw-r--r-- | runtime/doc/eval.txt | 9 | ||||
| -rw-r--r-- | runtime/doc/msgpack_rpc.txt | 4 | ||||
| -rw-r--r-- | runtime/doc/various.txt | 1 | ||||
| -rwxr-xr-x | runtime/doc/vim2html.pl | 228 |
5 files changed, 7 insertions, 243 deletions
diff --git a/runtime/doc/Makefile b/runtime/doc/Makefile index 85b92c7788..48674a773f 100644 --- a/runtime/doc/Makefile +++ b/runtime/doc/Makefile @@ -301,7 +301,7 @@ doctags: doctags.c manpages: $(MANPAGES) -# OSX groff dosn't support utf-8 as input encoding, so this won't work there. +# OSX groff doesn't support utf-8 as input encoding, so this won't work there. .1.man: groff -k -mandoc -Tutf8 $< | sed -e s/.^H//g > $@ @@ -328,12 +328,6 @@ vimindex.html: index.txt tags.ref tags.html: tags $(AWK) -f maketags.awk tags >tags.html -# Perl version of .txt to .html conversion. -# There can't be two rules to produce a .html from a .txt file. -# Just run over all .txt files each time one changes. It's fast anyway. -perlhtml: tags $(DOCS) - ./vim2html.pl tags $(DOCS) - clean: -rm -f doctags *.html tags.ref $(MANPAGES) $(HTMLS) errors.log diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 7624092470..869c416b88 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -4027,7 +4027,7 @@ jobstart({name}, {prog}[, {argv}]) {Nvim} *jobstart()* See |job-control| for more information. jobstop({job}) {Nvim} *jobstop()* - Stop a job created with |jobstart| by sending a `SIGTERM` + Stop a job created with |jobstart()| by sending a `SIGTERM` to the corresponding process. If the process doesn't exit cleanly soon, a `SIGKILL` will be sent. When the job is finally closed, a |JobActivity| event will trigger with @@ -5094,12 +5094,12 @@ rpcstart({prog}[, {argv}]) {Nvim} *rpcstart()* |rpcnotify()| and |rpcstop()| - 0 on failure. Example: > - :let rpc_chan = rpcstart('prog', ['arg1', 'arg2']) + :let rpc_chan = rpcstart('prog', ['arg1', 'arg2']) rpcstop({channel}) {Nvim} *rpcstop()* Closes a |msgpack-rpc| channel, possibly created via - |rpcspawn()| (Though it will also close channels created by - connections to |NVIM_LISTEN_ADDRESS|). It accepts the rpc + |rpcstart()| (Though it will also close channels created by + connections to |$NVIM_LISTEN_ADDRESS|). It accepts the rpc channel id as only argument. screenattr(row, col) *screenattr()* @@ -6714,7 +6714,6 @@ gui_photon Compiled with Photon GUI. gui_running Vim is running in the GUI, or it will start soon. gui_win32 Compiled with MS Windows Win32 GUI. gui_win32s idem, and Win32s system being used (Windows 3.1) -hangul_input Compiled with Hangul input support. iconv Can use iconv() for conversion. insert_expand Compiled with support for CTRL-X expansion commands in Insert mode. diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt index eb15075d85..8567f4a00e 100644 --- a/runtime/doc/msgpack_rpc.txt +++ b/runtime/doc/msgpack_rpc.txt @@ -234,12 +234,12 @@ Four functions related to msgpack-rpc are available to vimscript: the job's stdin/stdout combo are used as a msgpack channel that is processed directly by Nvim C code). - |rpcstop()|: Same as |jobstop()|, but operates on handles returned by - |rpcstart().| + |rpcstart()|. - |rpcrequest()|: Sends a msgpack-rpc request to the process. - |rpcnotify()|: Sends a msgpack-rpc notification to the process. The last two functions may also be used with channels created from -connections to |NVIM_LISTEN_ADDRESS|. +connections to |$NVIM_LISTEN_ADDRESS|. ============================================================================== vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt index e032fd8723..c3c4ed7cfe 100644 --- a/runtime/doc/various.txt +++ b/runtime/doc/various.txt @@ -348,7 +348,6 @@ N *+gettext* message translations |multi-lang| *+GUI_neXtaw* Unix only: neXtaw |GUI| *+GUI_GTK* Unix only: GTK+ |GUI| *+GUI_Motif* Unix only: Motif |GUI| -m *+hangul_input* Hangul input support hangul *+iconv* Compiled with the |iconv()| function *+iconv/dyn* Likewise |iconv-dynamic| |/dyn| N *+insert_expand* |insert_expand| Insert mode completion diff --git a/runtime/doc/vim2html.pl b/runtime/doc/vim2html.pl deleted file mode 100755 index 9066b03b16..0000000000 --- a/runtime/doc/vim2html.pl +++ /dev/null @@ -1,228 +0,0 @@ -#!/usr/bin/env perl - -# converts vim documentation to simple html -# Sirtaj Singh Kang (taj@kde.org) - -# Sun Feb 24 14:49:17 CET 2002 - -use strict; -use vars qw/%url $date/; - -%url = (); -$date = `date`; -chop $date; - -sub maplink -{ - my $tag = shift; - if( exists $url{ $tag } ){ - return $url{ $tag }; - } else { - #warn "Unknown hyperlink target: $tag\n"; - $tag =~ s/\.txt//; - $tag =~ s/</</g; - $tag =~ s/>/>/g; - return "<code class=\"badlink\">$tag</code>"; - } -} - -sub readTagFile -{ - my($tagfile) = @_; - my( $tag, $file, $name ); - - open(TAGS,"$tagfile") || die "can't read tags\n"; - - while( <TAGS> ) { - next unless /^(\S+)\s+(\S+)\s+/; - - $tag = $1; - my $label = $tag; - ($file= $2) =~ s/.txt$/.html/g; - $label =~ s/\.txt//; - - $url{ $tag } = "<a href=\"$file#".escurl($tag)."\">".esctext($label)."</a>"; - } - close( TAGS ); -} - -sub esctext -{ - my $text = shift; - $text =~ s/&/&/g; - $text =~ s/</</g; - $text =~ s/>/>/g; - return $text; -} - -sub escurl -{ - my $url = shift; - $url =~ s/"/%22/g; - $url =~ s/~/%7E/g; - $url =~ s/</%3C/g; - $url =~ s/>/%3E/g; - $url =~ s/=/%20/g; - $url =~ s/#/%23/g; - $url =~ s/\//%2F/g; - - return $url; -} - -sub vim2html -{ - my( $infile ) = @_; - my( $outfile ); - - open(IN, "$infile" ) || die "Couldn't read from $infile: $!.\n"; - - ($outfile = $infile) =~ s:.*/::g; - $outfile =~ s/\.txt$//g; - - open( OUT, ">$outfile.html" ) - || die "Couldn't write to $outfile.html: $!.\n"; - my $head = uc( $outfile ); - - print OUT<<EOF; -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>VIM: $outfile</title> -<link rel="stylesheet" href="vim-stylesheet.css" type="text/css"> -</head> -<body> -<h2>$head</h2> -<pre> -EOF - - my $inexample = 0; - while( <IN> ) { - chop; - if ( /^\s*[-=]+\s*$/ ) { - print OUT "</pre><hr><pre>"; - next; - } - - # examples - elsif( /^>$/ || /\s>$/ ) { - $inexample = 1; - chop; - } - elsif ( $inexample && /^([<\S])/ ) { - $inexample = 0; - $_ = $' if $1 eq "<"; - } - - s/\s+$//g; - - # Various vim highlights. note that < and > have already been escaped - # so that HTML doesn't get screwed up. - - my @out = (); - # print "Text: $_\n"; - LOOP: - foreach my $token ( split /((?:\|[^\|]+\|)|(?:\*[^\*]+\*))/ ) { - if ( $token =~ /^\|([^\|]+)\|/ ) { - # link - push( @out, "|".maplink( $1 )."|" ); - next LOOP; - } - elsif ( $token =~ /^\*([^\*]+)\*/ ) { - # target - push( @out, - "<b class=\"vimtag\">\*<a name=\"".escurl($1)."\">".esctext($1)."<\/a>\*<\/b>"); - next LOOP; - } - - $_ = esctext($token); - s/CTRL-(\w+)/<code class="keystroke">CTRL-$1<\/code>/g; - # parameter <...> - s/<(.*?)>/<code class="special"><$1><\/code>/g; - - # parameter {...} - s/\{([^}]*)\}/<code class="special">{$1}<\/code>/g; - - # parameter [...] - s/\[(range|line|count|offset|cmd|[-+]?num)\]/<code class="special">\[$1\]<\/code>/g; - # note - s/(Note:?)/<code class="note">$1<\/code>/gi; - - # local heading - s/^(.*)\~$/<code class="section">$1<\/code>/g; - push( @out, $_ ); - } - - $_ = join( "", @out ); - - if( $inexample == 2 ) { - print OUT "<code class=\"example\">$_</code>\n"; - } else { - print OUT $_,"\n"; - } - - $inexample = 2 if $inexample == 1; - } - print OUT<<EOF; -</pre> -<p><i>Generated by vim2html on $date</i></p> -</body> -</html> -EOF - -} - -sub usage -{ -die<<EOF; -vim2html.pl: converts vim documentation to HTML. -usage: - - vim2html.pl <tag file> <text files> -EOF -} - - -sub writeCSS -{ - open( CSS, ">vim-stylesheet.css" ) || die "Couldn't write stylesheet: $!\n"; - print CSS<<EOF; -body { background-color: white; color: black;} -:link { color: rgb(0,137,139); } -:visited { color: rgb(0,100,100); - background-color: white; /* should be inherit */ } -:active { color: rgb(0,200,200); - background-color: white; /* should be inherit */ } - -B.vimtag { color : rgb(250,0,250); } - -h1, h2 { color: rgb(82,80,82); text-align: center; } -h3, h4, h5, h6 { color: rgb(82,80,82); } -.headline { color: rgb(0,137,139); } -.header { color: rgb(164, 32, 246); } -.section { color: rgb(164, 32, 246); } -.keystroke { color: rgb(106, 89, 205); } -.vim { } -.example { color: rgb(0, 0, 255); } -.option { } -.notvi { } -.special { color: rgb(106, 89, 205); } -.note { color: blue; background-color: yellow; } -.sub {} -.badlink { color: rgb(0,37,39); } -EOF - -} - -# main -usage() if $#ARGV < 1; - -print "Processing tags...\n"; -readTagFile( $ARGV[ 0 ] ); - -foreach my $file ( 1..$#ARGV ) { - print "Processing ".$ARGV[ $file ]."...\n"; - vim2html( $ARGV[ $file ] ); -} -print "Writing stylesheet...\n"; -writeCSS(); -print "done.\n" |