Sophie

Sophie

distrib > Fedora > 20 > x86_64 > by-pkgid > d9f573299e87e886807be879704f0b6e > files > 157

julia-doc-0.3.4-1.fc20.noarch.rpm




<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Package Manager Functions &mdash; Julia Language 0.3.4 documentation</title>
  

  
  

  
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  
  
    

  

  
  
    <link rel="stylesheet" href="../_static/julia.css" type="text/css" />
  

  
    <link rel="stylesheet" href="../_static/julia.css" type="text/css" />
  
    <link rel="top" title="Julia Language 0.3.4 documentation" href="../index.html"/>
        <link rel="next" title="Collections and Data Structures" href="collections.html"/>
        <link rel="prev" title="Sorting and Related Functions" href="sort.html"/> 

  
  <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-nav-search">
        <a href="http://julialang.org/"><img src="../_static/julia-logo.svg" class="logo"></a>
        <!--
        <a href="../index.html" class="fa fa-home"> Julia Language</a>
        -->
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        
        
            <ul>
<li class="toctree-l1"><a class="reference internal" href="../manual/introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../manual/getting-started.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/getting-started.html#resources">Resources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/variables.html">Variables</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/variables.html#allowed-variable-names">Allowed Variable Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/variables.html#stylistic-conventions">Stylistic Conventions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/integers-and-floating-point-numbers.html">Integers and Floating-Point Numbers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/integers-and-floating-point-numbers.html#integers">Integers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/integers-and-floating-point-numbers.html#floating-point-numbers">Floating-Point Numbers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/integers-and-floating-point-numbers.html#arbitrary-precision-arithmetic">Arbitrary Precision Arithmetic</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/integers-and-floating-point-numbers.html#numeric-literal-coefficients">Numeric Literal Coefficients</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/integers-and-floating-point-numbers.html#literal-zero-and-one">Literal zero and one</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/mathematical-operations.html">Mathematical Operations and Elementary Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/mathematical-operations.html#arithmetic-operators">Arithmetic Operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/mathematical-operations.html#bitwise-operators">Bitwise Operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/mathematical-operations.html#updating-operators">Updating operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/mathematical-operations.html#numeric-comparisons">Numeric Comparisons</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/mathematical-operations.html#elementary-functions">Elementary Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/complex-and-rational-numbers.html">Complex and Rational Numbers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/complex-and-rational-numbers.html#complex-numbers">Complex Numbers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/complex-and-rational-numbers.html#rational-numbers">Rational Numbers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/strings.html">Strings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#characters">Characters</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#string-basics">String Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#unicode-and-utf-8">Unicode and UTF-8</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#interpolation">Interpolation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#common-operations">Common Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#non-standard-string-literals">Non-Standard String Literals</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#regular-expressions">Regular Expressions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#id3">Byte Array Literals</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/strings.html#version-number-literals">Version Number Literals</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/functions.html">Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#argument-passing-behavior">Argument Passing Behavior</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#the-return-keyword">The <tt class="docutils literal"><span class="pre">return</span></tt> Keyword</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#id1">Operators Are Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#operators-with-special-names">Operators With Special Names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#anonymous-functions">Anonymous Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#multiple-return-values">Multiple Return Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#varargs-functions">Varargs Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#optional-arguments">Optional Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#keyword-arguments">Keyword Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#evaluation-scope-of-default-values">Evaluation Scope of Default Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#block-syntax-for-function-arguments">Block Syntax for Function Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/functions.html#further-reading">Further Reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/control-flow.html">Control Flow</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/control-flow.html#compound-expressions">Compound Expressions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/control-flow.html#conditional-evaluation">Conditional Evaluation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/control-flow.html#short-circuit-evaluation">Short-Circuit Evaluation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/control-flow.html#repeated-evaluation-loops">Repeated Evaluation: Loops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/control-flow.html#exception-handling">Exception Handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/control-flow.html#tasks-aka-coroutines">Tasks (aka Coroutines)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/variables-and-scoping.html">Scope of Variables</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/variables-and-scoping.html#for-loops-and-comprehensions">For Loops and Comprehensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/variables-and-scoping.html#constants">Constants</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/types.html">Types</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#type-declarations">Type Declarations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#abstract-types">Abstract Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#bits-types">Bits Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#composite-types">Composite Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#immutable-composite-types">Immutable Composite Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#declared-types">Declared Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#tuple-types">Tuple Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#type-unions">Type Unions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#man-parametric-types">Parametric Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#type-aliases">Type Aliases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/types.html#operations-on-types">Operations on Types</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/methods.html">Methods</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/methods.html#defining-methods">Defining Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/methods.html#method-ambiguities">Method Ambiguities</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/methods.html#parametric-methods">Parametric Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/methods.html#note-on-optional-and-keyword-arguments">Note on Optional and keyword Arguments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/constructors.html">Constructors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/constructors.html#outer-constructor-methods">Outer Constructor Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/constructors.html#inner-constructor-methods">Inner Constructor Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/constructors.html#incomplete-initialization">Incomplete Initialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/constructors.html#parametric-constructors">Parametric Constructors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/constructors.html#case-study-rational">Case Study: Rational</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/conversion-and-promotion.html">Conversion and Promotion</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/conversion-and-promotion.html#conversion">Conversion</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/conversion-and-promotion.html#promotion">Promotion</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/modules.html">Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/modules.html#summary-of-module-usage">Summary of module usage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/metaprogramming.html">Metaprogramming</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/metaprogramming.html#expressions-and-eval">Expressions and Eval</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/metaprogramming.html#macros">Macros</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/metaprogramming.html#reflection">Reflection</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/arrays.html">Multi-dimensional Arrays</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/arrays.html#arrays">Arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/arrays.html#sparse-matrices">Sparse Matrices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/linear-algebra.html">Linear algebra</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/linear-algebra.html#matrix-factorizations">Matrix factorizations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/linear-algebra.html#special-matrices">Special matrices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/networking-and-streams.html">Networking and Streams</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/networking-and-streams.html#basic-stream-i-o">Basic Stream I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/networking-and-streams.html#text-i-o">Text I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/networking-and-streams.html#working-with-files">Working with Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/networking-and-streams.html#a-simple-tcp-example">A simple TCP example</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/networking-and-streams.html#resolving-ip-addresses">Resolving IP Addresses</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/parallel-computing.html">Parallel Computing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#data-movement">Data Movement</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#parallel-map-and-loops">Parallel Map and Loops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#synchronization-with-remote-references">Synchronization With Remote References</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#scheduling">Scheduling</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#distributed-arrays">Distributed Arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#constructing-distributed-arrays">Constructing Distributed Arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#distributed-array-operations">Distributed Array Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#shared-arrays-experimental">Shared Arrays (Experimental)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/parallel-computing.html#clustermanagers">ClusterManagers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/running-external-programs.html">Running External Programs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/running-external-programs.html#interpolation">Interpolation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/running-external-programs.html#quoting">Quoting</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/running-external-programs.html#pipelines">Pipelines</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html">Calling C and Fortran Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#mapping-c-types-to-julia">Mapping C Types to Julia</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#accessing-data-through-a-pointer">Accessing Data through a Pointer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#passing-pointers-for-modifying-inputs">Passing Pointers for Modifying Inputs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#garbage-collection-safety">Garbage Collection Safety</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#non-constant-function-specifications">Non-constant Function Specifications</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#indirect-calls">Indirect Calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#calling-convention">Calling Convention</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#accessing-global-variables">Accessing Global Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#passing-julia-callback-functions-to-c">Passing Julia Callback Functions to C</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#c">C++</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/calling-c-and-fortran-code.html#handling-platform-variations">Handling Platform Variations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/interacting-with-julia.html">Interacting With Julia</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/interacting-with-julia.html#the-different-prompt-modes">The different prompt modes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/interacting-with-julia.html#key-bindings">Key bindings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/embedding.html">Embedding Julia</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/embedding.html#high-level-embedding">High-Level Embedding</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/embedding.html#converting-types">Converting Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/embedding.html#calling-julia-functions">Calling Julia Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/embedding.html#memory-management">Memory Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/embedding.html#working-with-arrays">Working with Arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/embedding.html#exceptions">Exceptions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/packages.html">Packages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#package-status">Package Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#adding-and-removing-packages">Adding and Removing Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#installing-unregistered-packages">Installing Unregistered Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#updating-packages">Updating Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#checkout-pin-and-free">Checkout, Pin and Free</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/packages.html#package-development">Package Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#initial-setup">Initial Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#generating-a-new-package">Generating a New Package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#making-your-package-available">Making Your Package Available</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#publishing-your-package">Publishing Your Package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#tagging-package-versions">Tagging Package Versions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#fixing-package-requirements">Fixing Package Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/packages.html#man-package-requirements">Requirements Specification</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/performance-tips.html">Performance Tips</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#avoid-global-variables">Avoid global variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#measure-performance-with-time-and-pay-attention-to-memory-allocation">Measure performance with <tt class="docutils literal"><span class="pre">&#64;time</span></tt> and pay attention to memory allocation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#tools">Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#avoid-containers-with-abstract-type-parameters">Avoid containers with abstract type parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#type-declarations">Type declarations</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#break-functions-into-multiple-definitions">Break functions into multiple definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#write-type-stable-functions">Write &#8220;type-stable&#8221; functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#avoid-changing-the-type-of-a-variable">Avoid changing the type of a variable</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#separate-kernel-functions">Separate kernel functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#access-arrays-in-memory-order-along-columns">Access arrays in memory order, along columns</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#pre-allocating-outputs">Pre-allocating outputs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#avoid-string-interpolation-for-i-o">Avoid string interpolation for I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#fix-deprecation-warnings">Fix deprecation warnings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#tweaks">Tweaks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/performance-tips.html#performance-annotations">Performance Annotations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/style-guide.html">Style Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#write-functions-not-just-scripts">Write functions, not just scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#avoid-writing-overly-specific-types">Avoid writing overly-specific types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#handle-excess-argument-diversity-in-the-caller">Handle excess argument diversity in the caller</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#append-to-names-of-functions-that-modify-their-arguments">Append <cite>!</cite> to names of functions that modify their arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#avoid-strange-type-unions">Avoid strange type Unions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#try-to-avoid-nullable-fields">Try to avoid nullable fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#avoid-elaborate-container-types">Avoid elaborate container types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#avoid-underscores-in-names">Avoid underscores in names</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#don-t-overuse-try-catch">Don&#8217;t overuse try-catch</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#don-t-parenthesize-conditions">Don&#8217;t parenthesize conditions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#don-t-overuse">Don&#8217;t overuse ...</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#don-t-use-unnecessary-static-parameters">Don&#8217;t use unnecessary static parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#avoid-confusion-about-whether-something-is-an-instance-or-a-type">Avoid confusion about whether something is an instance or a type</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#don-t-overuse-macros">Don&#8217;t overuse macros</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#don-t-expose-unsafe-operations-at-the-interface-level">Don&#8217;t expose unsafe operations at the interface level</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#don-t-overload-methods-of-base-container-types">Don&#8217;t overload methods of base container types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#be-careful-with-type-equality">Be careful with type equality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/style-guide.html#do-not-write-x-f-x">Do not write <tt class="docutils literal"><span class="pre">x-&gt;f(x)</span></tt></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/faq.html">Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/faq.html#sessions-and-the-repl">Sessions and the REPL</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/faq.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/faq.html#types-type-declarations-and-constructors">Types, type declarations, and constructors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/faq.html#nothingness-and-missing-values">Nothingness and missing values</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/faq.html#julia-releases">Julia Releases</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/faq.html#developing-julia">Developing Julia</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../manual/noteworthy-differences.html">Noteworthy Differences from other Languages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../manual/noteworthy-differences.html#noteworthy-differences-from-matlab">Noteworthy differences from MATLAB</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/noteworthy-differences.html#noteworthy-differences-from-r">Noteworthy differences from R</a></li>
<li class="toctree-l2"><a class="reference internal" href="../manual/noteworthy-differences.html#noteworthy-differences-from-python">Noteworthy differences from Python</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="base.html">The Standard Library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="base.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#getting-around">Getting Around</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#all-objects">All Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#types">Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#generic-functions">Generic Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#syntax">Syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#iteration">Iteration</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#general-collections">General Collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#iterable-collections">Iterable Collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#indexable-collections">Indexable Collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#associative-collections">Associative Collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#set-like-collections">Set-Like Collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#dequeues">Dequeues</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#strings">Strings</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#i-o">I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#network-i-o">Network I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#text-i-o">Text I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#multimedia-i-o">Multimedia I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#memory-mapped-i-o">Memory-mapped I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#standard-numeric-types">Standard Numeric Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#mathematical-operators">Mathematical Operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#mathematical-functions">Mathematical Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#data-formats">Data Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#numbers">Numbers</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#bigfloats">BigFloats</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#random-numbers">Random Numbers</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#arrays">Arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#combinatorics">Combinatorics</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#statistics">Statistics</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#signal-processing">Signal Processing</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#numerical-integration">Numerical Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#parallel-computing">Parallel Computing</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#distributed-arrays">Distributed Arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#shared-arrays-experimental-unix-only-feature">Shared Arrays (Experimental, UNIX-only feature)</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#system">System</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#c-interface">C Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#errors">Errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#tasks">Tasks</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#events">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#reflection">Reflection</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html#internals">Internals</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="sparse.html">Sparse Matrices</a></li>
<li class="toctree-l1"><a class="reference internal" href="linalg.html">Linear Algebra</a></li>
<li class="toctree-l1"><a class="reference internal" href="linalg.html#module-Base.LinAlg.BLAS">BLAS Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="constants.html">Constants</a></li>
<li class="toctree-l1"><a class="reference internal" href="file.html">Filesystem</a></li>
<li class="toctree-l1"><a class="reference internal" href="punctuation.html">Punctuation</a></li>
<li class="toctree-l1"><a class="reference internal" href="sort.html">Sorting and Related Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sort.html#sorting-functions">Sorting Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="sort.html#order-related-functions">Order-Related Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="sort.html#sorting-algorithms">Sorting Algorithms</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Package Manager Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="collections.html">Collections and Data Structures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="collections.html#priorityqueue">PriorityQueue</a></li>
<li class="toctree-l2"><a class="reference internal" href="collections.html#heap-functions">Heap Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="graphics.html">Graphics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="graphics.html#geometry">Geometry</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="test.html">Unit and Functional Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="test.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html#handlers">Handlers</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html#macros">Macros</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="test.html#testing-base-julia">Testing Base Julia</a></li>
<li class="toctree-l1"><a class="reference internal" href="profile.html">Profiling</a><ul>
<li class="toctree-l2"><a class="reference internal" href="profile.html#basic-usage">Basic usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#accumulation-and-clearing">Accumulation and clearing</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#options-for-controlling-the-display-of-profile-results">Options for controlling the display of profile results</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile.html#function-reference">Function reference</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../devdocs/julia.html">Documentation of Julia&#8217;s Internals</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../devdocs/cartesian.html">Base.Cartesian</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devdocs/sysimg.html">System Image Building</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../devdocs/C.html">Developing/debugging Julia&#8217;s C code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../devdocs/backtraces.html">Reporting and analyzing crashes (segfaults)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../devdocs/debuggingtips.html">gdb debugging tips</a></li>
</ul>
</li>
</ul>

        
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index.html">Julia Language</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index.html">Docs</a> &raquo;</li>
      
    <li>Package Manager Functions</li>
      <li class="wy-breadcrumbs-aside">
        
          <a href="../_sources/stdlib/pkg.txt" rel="nofollow"> View page source</a>
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document">
            
  <span class="target" id="module-Base.Pkg"></span><div class="section" id="package-manager-functions">
<h1>Package Manager Functions<a class="headerlink" href="#package-manager-functions" title="Permalink to this headline">¶</a></h1>
<p>All Package manager functions are defined in the <tt class="docutils literal"><span class="pre">Pkg</span></tt> module; note that none of the <tt class="docutils literal"><span class="pre">Pkg</span></tt> module&#8217;s functions are exported;
to use them, you&#8217;ll need to prefix each function call with an explicit <tt class="docutils literal"><span class="pre">Pkg.</span></tt>, e.g. <tt class="docutils literal"><span class="pre">Pkg.status()</span></tt> or <tt class="docutils literal"><span class="pre">Pkg.dir()</span></tt>.</p>
<dl class="function">
<dt id="Base.Pkg.dir">
<tt class="descname">dir</tt><big>(</big><big>)</big> &rarr; String<a class="headerlink" href="#Base.Pkg.dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the absolute path of the package directory.
This defaults to <tt class="docutils literal"><span class="pre">joinpath(homedir(),&quot;.julia&quot;)</span></tt> on all platforms (i.e. <tt class="docutils literal"><span class="pre">~/.julia</span></tt> in UNIX shell syntax).
If the <tt class="docutils literal"><span class="pre">JULIA_PKGDIR</span></tt> environment variable is set, that path is used instead.
If <tt class="docutils literal"><span class="pre">JULIA_PKGDIR</span></tt> is a relative path, it is interpreted relative to whatever the current working directory is.</p>
</dd></dl>

<dl class="function">
<dt>
<tt class="descname">dir</tt><big>(</big><em>names...</em><big>)</big> &rarr; String</dt>
<dd><p>Equivalent to <tt class="docutils literal"><span class="pre">normpath(Pkg.dir(),names...)</span></tt> – i.e. it appends path components to the package directory and normalizes the resulting path.
In particular, <tt class="docutils literal"><span class="pre">Pkg.dir(pkg)</span></tt> returns the path to the package <tt class="docutils literal"><span class="pre">pkg</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.init">
<tt class="descname">init</tt><big>(</big><em>meta::String=DEFAULT_META</em>, <em>branch::String=META_BRANCH</em><big>)</big><a class="headerlink" href="#Base.Pkg.init" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize <tt class="docutils literal"><span class="pre">Pkg.dir()</span></tt> as a package directory.
This will be done automatically when the <tt class="docutils literal"><span class="pre">JULIA_PKGDIR</span></tt> is not set and <tt class="docutils literal"><span class="pre">Pkg.dir()</span></tt> uses its default value.
As part of this process, clones a local METADATA git repository from the site and branch specified by its arguments, which
are typically not provided.  Explicit (non-default) arguments can be used to support a custom METADATA setup.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.resolve">
<tt class="descname">resolve</tt><big>(</big><big>)</big><a class="headerlink" href="#Base.Pkg.resolve" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines an optimal, consistent set of package versions to install or upgrade to.
The optimal set of package versions is based on the contents of <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;REQUIRE&quot;)</span></tt> and the state of installed packages in <tt class="docutils literal"><span class="pre">Pkg.dir()</span></tt>,
Packages that are no longer required are moved into <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;.trash&quot;)</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.edit">
<tt class="descname">edit</tt><big>(</big><big>)</big><a class="headerlink" href="#Base.Pkg.edit" title="Permalink to this definition">¶</a></dt>
<dd><p>Opens <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;REQUIRE&quot;)</span></tt> in the editor specified by the <tt class="docutils literal"><span class="pre">VISUAL</span></tt> or <tt class="docutils literal"><span class="pre">EDITOR</span></tt> environment variables;
when the editor command returns, it runs <tt class="docutils literal"><span class="pre">Pkg.resolve()</span></tt> to determine and install a new optimal set of installed package versions.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.add">
<tt class="descname">add</tt><big>(</big><em>pkg</em>, <em>vers...</em><big>)</big><a class="headerlink" href="#Base.Pkg.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a requirement entry for <tt class="docutils literal"><span class="pre">pkg</span></tt> to <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;REQUIRE&quot;)</span></tt> and call <tt class="docutils literal"><span class="pre">Pkg.resolve()</span></tt>.
If <tt class="docutils literal"><span class="pre">vers</span></tt> are given, they must be <tt class="docutils literal"><span class="pre">VersionNumber</span></tt> objects and they specify acceptable version intervals for <tt class="docutils literal"><span class="pre">pkg</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.rm">
<tt class="descname">rm</tt><big>(</big><em>pkg</em><big>)</big><a class="headerlink" href="#Base.Pkg.rm" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove all requirement entries for <tt class="docutils literal"><span class="pre">pkg</span></tt> from <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;REQUIRE&quot;)</span></tt> and call <tt class="docutils literal"><span class="pre">Pkg.resolve()</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.clone">
<tt class="descname">clone</tt><big>(</big><em>url</em><span class="optional">[</span>, <em>pkg</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Base.Pkg.clone" title="Permalink to this definition">¶</a></dt>
<dd><p>Clone a package directly from the git URL <tt class="docutils literal"><span class="pre">url</span></tt>.
The package does not need to be a registered in <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;METADATA&quot;)</span></tt>.
The package repo is cloned by the name <tt class="docutils literal"><span class="pre">pkg</span></tt> if provided;
if not provided, <tt class="docutils literal"><span class="pre">pkg</span></tt> is determined automatically from <tt class="docutils literal"><span class="pre">url</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt>
<tt class="descname">clone</tt><big>(</big><em>pkg</em><big>)</big></dt>
<dd><p>If <tt class="docutils literal"><span class="pre">pkg</span></tt> has a URL registered in <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;METADATA&quot;)</span></tt>, clone it from that URL on the default branch.
The package does not need to have any registered versions.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.available">
<tt class="descname">available</tt><big>(</big><big>)</big> &rarr; Vector{ASCIIString}<a class="headerlink" href="#Base.Pkg.available" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the names of available packages.</p>
</dd></dl>

<dl class="function">
<dt>
<tt class="descname">available</tt><big>(</big><em>pkg</em><big>)</big> &rarr; Vector{VersionNumber}</dt>
<dd><p>Returns the version numbers available for package <tt class="docutils literal"><span class="pre">pkg</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.installed">
<tt class="descname">installed</tt><big>(</big><big>)</big> &rarr; Dict{ASCIIString,VersionNumber}<a class="headerlink" href="#Base.Pkg.installed" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary mapping installed package names to the installed version number of each package.</p>
</dd></dl>

<dl class="function">
<dt>
<tt class="descname">installed</tt><big>(</big><em>pkg</em><big>)</big> &rarr; Nothing | VersionNumber</dt>
<dd><p>If <tt class="docutils literal"><span class="pre">pkg</span></tt> is installed, return the installed version number, otherwise return <tt class="docutils literal"><span class="pre">nothing</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.status">
<tt class="descname">status</tt><big>(</big><big>)</big><a class="headerlink" href="#Base.Pkg.status" title="Permalink to this definition">¶</a></dt>
<dd><p>Prints out a summary of what packages are installed and what version and state they&#8217;re in.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.update">
<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#Base.Pkg.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update package the metadata repo –&nbsp;kept in <tt class="docutils literal"><span class="pre">Pkg.dir(&quot;METADATA&quot;)</span></tt> –&nbsp;then update any fixed packages that can safely be pulled from their origin;
then call <tt class="docutils literal"><span class="pre">Pkg.resolve()</span></tt> to determine a new optimal set of packages versions.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.checkout">
<tt class="descname">checkout</tt><big>(</big><em>pkg</em><span class="optional">[</span>, <em>branch=&quot;master&quot;</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Base.Pkg.checkout" title="Permalink to this definition">¶</a></dt>
<dd><p>Checkout the <tt class="docutils literal"><span class="pre">Pkg.dir(pkg)</span></tt> repo to the branch <tt class="docutils literal"><span class="pre">branch</span></tt>.
Defaults to checking out the &#8220;master&#8221; branch.
To go back to using the newest compatible released version, use <tt class="docutils literal"><span class="pre">Pkg.free(pkg)</span></tt></p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.pin">
<tt class="descname">pin</tt><big>(</big><em>pkg</em><big>)</big><a class="headerlink" href="#Base.Pkg.pin" title="Permalink to this definition">¶</a></dt>
<dd><p>Pin <tt class="docutils literal"><span class="pre">pkg</span></tt> at the current version.
To go back to using the newest compatible released version, use <tt class="docutils literal"><span class="pre">Pkg.free(pkg)</span></tt></p>
</dd></dl>

<dl class="function">
<dt>
<tt class="descname">pin</tt><big>(</big><em>pkg</em>, <em>version</em><big>)</big></dt>
<dd><p>Pin <tt class="docutils literal"><span class="pre">pkg</span></tt> at registered version <tt class="docutils literal"><span class="pre">version</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.free">
<tt class="descname">free</tt><big>(</big><em>pkg</em><big>)</big><a class="headerlink" href="#Base.Pkg.free" title="Permalink to this definition">¶</a></dt>
<dd><p>Free the package <tt class="docutils literal"><span class="pre">pkg</span></tt> to be managed by the package manager again.
It calls <tt class="docutils literal"><span class="pre">Pkg.resolve()</span></tt> to determine optimal package versions after.
This is an inverse for both <tt class="docutils literal"><span class="pre">Pkg.checkout</span></tt> and <tt class="docutils literal"><span class="pre">Pkg.pin</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.build">
<tt class="descname">build</tt><big>(</big><big>)</big><a class="headerlink" href="#Base.Pkg.build" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the build scripts for all installed packages in depth-first recursive order.</p>
</dd></dl>

<dl class="function">
<dt>
<tt class="descname">build</tt><big>(</big><em>pkgs...</em><big>)</big></dt>
<dd><p>Run the build script in &#8220;deps/build.jl&#8221; for each package in <tt class="docutils literal"><span class="pre">pkgs</span></tt> and all of their dependencies in depth-first recursive order.
This is called automatically by <tt class="docutils literal"><span class="pre">Pkg.resolve()</span></tt> on all installed or updated packages.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.generate">
<tt class="descname">generate</tt><big>(</big><em>pkg</em>, <em>license</em><big>)</big><a class="headerlink" href="#Base.Pkg.generate" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate a new package named <tt class="docutils literal"><span class="pre">pkg</span></tt> with one of these license keys: <tt class="docutils literal"><span class="pre">&quot;MIT&quot;</span></tt> or <tt class="docutils literal"><span class="pre">&quot;BSD&quot;</span></tt>.
If you want to make a package with a different license, you can edit it afterwards.
Generate creates a git repo at <tt class="docutils literal"><span class="pre">Pkg.dir(pkg)</span></tt> for the package and inside it <tt class="docutils literal"><span class="pre">LICENSE.md</span></tt>, <tt class="docutils literal"><span class="pre">README.md</span></tt>, the julia entrypoint <tt class="docutils literal"><span class="pre">$pkg/src/$pkg.jl</span></tt>, and a travis test file, <tt class="docutils literal"><span class="pre">.travis.yml</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.register">
<tt class="descname">register</tt><big>(</big><em>pkg</em><span class="optional">[</span>, <em>url</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#Base.Pkg.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Register <tt class="docutils literal"><span class="pre">pkg</span></tt> at the git URL <tt class="docutils literal"><span class="pre">url</span></tt>, defaulting to the configured origin URL of the git repo <tt class="docutils literal"><span class="pre">Pkg.dir(pkg)</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.tag">
<tt class="descname">tag</tt><big>(</big><em>pkg</em><span class="optional">[</span>, <em>ver</em><span class="optional">[</span>, <em>commit</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#Base.Pkg.tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Tag <tt class="docutils literal"><span class="pre">commit</span></tt> as version <tt class="docutils literal"><span class="pre">ver</span></tt> of package <tt class="docutils literal"><span class="pre">pkg</span></tt> and create a version entry in <tt class="docutils literal"><span class="pre">METADATA</span></tt>.
If not provided, <tt class="docutils literal"><span class="pre">commit</span></tt> defaults to the current commit of the <tt class="docutils literal"><span class="pre">pkg</span></tt> repo.
If <tt class="docutils literal"><span class="pre">ver</span></tt> is one of the symbols <tt class="docutils literal"><span class="pre">:patch</span></tt>, <tt class="docutils literal"><span class="pre">:minor</span></tt>, <tt class="docutils literal"><span class="pre">:major</span></tt> the next patch, minor or major version is used.
If <tt class="docutils literal"><span class="pre">ver</span></tt> is not provided, it defaults to <tt class="docutils literal"><span class="pre">:patch</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.publish">
<tt class="descname">publish</tt><big>(</big><big>)</big><a class="headerlink" href="#Base.Pkg.publish" title="Permalink to this definition">¶</a></dt>
<dd><p>For each new package version tagged in <tt class="docutils literal"><span class="pre">METADATA</span></tt> not already published, make sure that the tagged package commits have been pushed to the repo at the registered URL for the package and if they all have, open a pull request to <tt class="docutils literal"><span class="pre">METADATA</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt id="Base.Pkg.test">
<tt class="descname">test</tt><big>(</big><big>)</big><a class="headerlink" href="#Base.Pkg.test" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the tests for all installed packages ensuring that each package&#8217;s test dependencies are installed for the duration of the test. A package is tested by running its <tt class="docutils literal"><span class="pre">test/runtests.jl</span></tt> file and test dependencies are specified in <tt class="docutils literal"><span class="pre">test/REQUIRE</span></tt>.</p>
</dd></dl>

<dl class="function">
<dt>
<tt class="descname">test</tt><big>(</big><em>pkgs...</em><big>)</big></dt>
<dd><p>Run the tests for each package in <tt class="docutils literal"><span class="pre">pkgs</span></tt> ensuring that each package&#8217;s test dependencies are installed for the duration of the test. A package is tested by running its <tt class="docutils literal"><span class="pre">test/runtests.jl</span></tt> file and test dependencies are specified in <tt class="docutils literal"><span class="pre">test/REQUIRE</span></tt>.</p>
</dd></dl>

</div>


          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="collections.html" class="btn btn-neutral float-right" title="Collections and Data Structures"/>Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="sort.html" class="btn btn-neutral" title="Sorting and Related Functions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
    </p>
  </div>

  <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
</footer>
        </div>
      </div>

    </section>

  </div>
  

  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'0.3.4',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>
      <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  
  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>