summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/breakurl/README
blob: ddf1f1adcceac794733a27bed5a6344e97daa3a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
README for breakurl, version 1.20 (2006/08/26)


INTRODUCTION
============

The breakurl is an extension to hyperref package that allows line-breakable
\url-like links when compiling via latex + dvips + ps2pdf.


DESCRIPTION
===========

This package provides a command much like hyperref's \url that typesets a URL
using a typewriter-like font.  However, if the dvips driver is being used, the
original \url doesn't allow line breaks in the middle of the created link: the
link comes in one atomic piece.  This package allows such line breaks in the
generated links.

Note that this package is intended only for those using the dvips driver.
Users of the pdflatex driver already have this feature.


INSTALLATION
============

Eventually breakurl may be pre-configured on your system. These instructions
are relevant only if your LaTeX system complains about missing `breakurl.sty'.

If you use MiKTeX, the utility "MiKTeX Package Manager" (Start menu > Programs
> MiKTeX > Browse Packages or MiKTeX Package Manager) is your friend. Just
select `breakurl' and click on Task > Install.

f you need to do a manual installation (eventually needed under Unix-like
systems), following instructions may come in handy:

a) Download the package files from CTAN or the TUG server.

b) Generate the `breakurl.sty' file:

     latex breakurl.ins

c) Install the file `breakurl.sty' in your TDS tree:

     mkdir .../texmf/tex/latex/breakurl
     cp breakurl.sty .../texmf/tex/latex/breakurl/

   where `...' is the prefix of your TDS tree.

d) Update the databases if necessary, eg. for teTeX:

     mktexlsr .../texmf

   or for MiKTeX: Click Start menu > Programs > MiKTeX 2.5 > Settings, open the
   General tab (this is the default) and click in the `Refresh FNDB' button. If
   you're using MiKTeX 2.4, the path is Start menu > Programs > MiKTeX > MiKTeX
   Options > General > Refresh Now.


DOCUMENTATION
=============

Please see the breakurl.pdf for a more comprehensive description of the
package, its options, issues, etc. Or generate a dvi version using the
following:

     latex breakurl.dtx


LICENSE
=======

This file may be distributed and/or modified under the conditions of the LaTeX
Project Public License, either version 1.2 of this license or (at your option)
any later version.  The latest version of this license is in:

    http://www.latex-project.org/lppl.txt

and version 1.2 or later is part of all distributions of LaTeX version
1999/12/01 or later.

-- 
Vilar Camara Neto
Belo Horizonte, Minas Gerais, Brazil
neto@dcc.ufmg.br