ipython.1 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. .\" Hey, EMACS: -*- nroff -*-
  2. .\" First parameter, NAME, should be all caps
  3. .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
  4. .\" other parameters are allowed: see man(7), man(1)
  5. .TH IPYTHON 1 "July 15, 2011"
  6. .\" Please adjust this date whenever revising the manpage.
  7. .\"
  8. .\" Some roff macros, for reference:
  9. .\" .nh disable hyphenation
  10. .\" .hy enable hyphenation
  11. .\" .ad l left justify
  12. .\" .ad b justify to both left and right margins
  13. .\" .nf disable filling
  14. .\" .fi enable filling
  15. .\" .br insert line break
  16. .\" .sp <n> insert n+1 empty lines
  17. .\" for manpage-specific macros, see man(7) and groff_man(7)
  18. .\" .SH section heading
  19. .\" .SS secondary section heading
  20. .\"
  21. .\"
  22. .\" To preview this page as plain text: nroff -man ipython.1
  23. .\"
  24. .SH NAME
  25. ipython \- Tools for Interactive Computing in Python.
  26. .SH SYNOPSIS
  27. .B ipython
  28. .RI [ options ] " files" ...
  29. .B ipython subcommand
  30. .RI [ options ] ...
  31. .SH DESCRIPTION
  32. An interactive Python shell with automatic history (input and output), dynamic
  33. object introspection, easier configuration, command completion, access to the
  34. system shell, integration with numerical and scientific computing tools,
  35. web notebook, Qt console, and more.
  36. For more information on how to use IPython, see 'ipython \-\-help',
  37. or 'ipython \-\-help\-all' for all available command\(hyline options.
  38. .SH "ENVIRONMENT VARIABLES"
  39. .sp
  40. .PP
  41. \fIIPYTHONDIR\fR
  42. .RS 4
  43. This is the location where IPython stores all its configuration files. The default
  44. is $HOME/.ipython if IPYTHONDIR is not defined.
  45. You can see the computed value of IPYTHONDIR with `ipython locate`.
  46. .SH FILES
  47. IPython uses various configuration files stored in profiles within IPYTHONDIR.
  48. To generate the default configuration files and start configuring IPython,
  49. do 'ipython profile create', and edit '*_config.py' files located in
  50. IPYTHONDIR/profile_default.
  51. .SH AUTHORS
  52. IPython is written by the IPython Development Team <https://github.com/ipython/ipython>.