.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "ChordPro::A2Crd 3pm"
.TH ChordPro::A2Crd 3pm 2024-04-12 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
ChordPro::A2Crd \- convert lyrics and chords to ChordPro
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  perl \-MA2Crd \-e run \-\- [ options ] [ file ... ]
.Ve
.PP
(But no one does that.)
.PP
When the associated \fBchordpro\fR program has been installed correctly:
.PP
.Vb 1
\&  chordpro \-\-a2crd [ options ] [ file ... ]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBThis program\fR, referred to as \fBa2crd\fR, will read a text file
containing the lyrics of one or many songs with chord information
written visually above the lyrics. This is often referred to as \fIcrd\fR
data. \fBa2crd\fR will then generate equivalent ChordPro output.
.PP
Typical a2crd input:
.PP
.Vb 1
\&    Title: Swing Low Sweet Chariot
\&
\&          D          G    D
\&    Swing low, sweet chariot,
\&                           A7
\&    Comin\*(Aq for to carry me home.
\&          D7         G    D
\&    Swing low, sweet chariot,
\&                  A7       D
\&    Comin\*(Aq for to carry me home.
\&
\&      D                       G          D
\&    I looked over Jordan, and what did I see,
\&                           A7
\&    Comin\*(Aq for to carry me home.
\&      D              G            D
\&    A band of angels comin\*(Aq after me,
\&                  A7       D
\&    Comin\*(Aq for to carry me home.
.Ve
.PP
Note that the output from the conversion will generally need some
additional editing to be useful as input to ChordPro.
.PP
\&\fBa2crd\fR is a wrapper around ChordPro::A2Crd, which
does all of the work.
.PP
\&\fBchordpro\fR will read one or more text files containing the lyrics of
one or many songs plus chord information. \fBchordpro\fR will then
generate a photo-ready, professional looking, impress-your-friends
sheet-music suitable for printing on your nearest printer.
.PP
\&\fBchordpro\fR is a rewrite of the Chordii program.
.PP
For more information about the ChordPro file format, see
<https://www.chordpro.org>.
.SH "COMMAND LINE OPTIONS"
.IX Header "COMMAND LINE OPTIONS"
.IP "\fB\-\-output=\fR\fIFILE\fR (short: \fB\-o\fR)" 4
.IX Item "--output=FILE (short: -o)"
Designates the name of the output file where the results are written
to. Default is standard output.
.IP "\fB\-\-version\fR (short: \fB\-V\fR)" 4
.IX Item "--version (short: -V)"
Prints the program version and exits.
.IP "\fB\-\-help\fR (short: \-h)" 4
.IX Item "--help (short: -h)"
Prints a help message. No other output is produced.
.IP \fB\-\-manual\fR 4
.IX Item "--manual"
Prints the manual page. No other output is produced.
.IP \fB\-\-ident\fR 4
.IX Item "--ident"
Shows the program name and version.
.IP \fB\-\-verbose\fR 4
.IX Item "--verbose"
Provides more verbose information of what is going on.
.SH AUTHOR
.IX Header "AUTHOR"
Johan Vromans \f(CW\*(C`<jv at CPAN dot org >\*(C'\fR
.SH SUPPORT
.IX Header "SUPPORT"
A2Crd is part of ChordPro (the program). Development is hosted on
GitHub, repository <https://github.com/ChordPro/chordpro>.
.PP
Please report any bugs or feature requests to the GitHub issue tracker,
<https://github.com/ChordPro/chordpro/issues>.
.PP
A user community discussing ChordPro can be found at
<https://groups.google.com/forum/#!forum/chordpro>.
.SH LICENSE
.IX Header "LICENSE"
Copyright (C) 2010,2018 Johan Vromans,
.PP
This program is free software. You can redistribute it and/or
modify it under the terms of the Artistic License 2.0.
.PP
This program is distributed in the hope that it will be useful,
but without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.