• Michael Tokarev's avatar
    Support utf8 chars in pod docs · 3179d694
    Michael Tokarev authored
    We've at least one UTF8 char in the qemu texi doc:
    
     $ grep Tibor qemu-doc.texi
     by Tibor "TS" Schütz.
     $ man ./qemu.1 | grep Tibor
            by Tibor "TS" SchA~Xtz.
    
    This patch allows utf8 in man/pod docs.
    
    Initially it was split into two parts and sent on 2012-02-02.
    Resending it again (3rd time) now in merged form.  If any
    other generalizations of $(POD2MAN) are needed it can be done
    in a separate patch.  Current form of $(POD2MAN) is choosen
    to be able to easily change it if some implementation does
    not support utf8 or resulting output has issues with local
    man(1) program/macros.
    
    First, add @documentencoding in scripts/texi2pod.pl:
    
    Currently our texi2pod ignores @documentencoding even if it is set
    properly in *.texi files.  This results in a mojibake in documents
    generated from qemu.pod (which is generated from qemu-doc.texi by
    texi2pod), because the rest of the tools assumes ASCII encoding.
    
    This patch recognizes first @documentencoding in input and places
    it at the beginning of output as =encoding directive.
    
    Second, run pod2man with --utf8 option to enable utf8 in manpages:
    
    This option makes no difference for manpages which contains only
    ascii chars.  But for manpages with actual UTF8 characters (qemu
    docs contains these), this change allows to see real characters
    instead of mojibakes or substitutes.
    Signed-off-By: default avatarMichael Tokarev <mjt@tls.msk.ru>
    Signed-off-by: default avatarBlue Swirl <blauwirbel@gmail.com>
    3179d694
texi2pod.pl 12.1 KB