Warning, /documentation/digikam-doc/index.rst is written in an unsupported language. File is not indexed.

0001 .. meta::
0002    :description: The digiKam User Manual
0003    :keywords: digiKam, documentation, user manual, photo management, open source, free, help, learn
0004 
0005 .. metadata-placeholder
0006 
0007    :authors: - digiKam Team
0008 
0009    :license: see Credits and License page for details (https://docs.digikam.org/en/credits_license.html)
0010 
0011 ###############
0012 digiKam Manual
0013 ###############
0014 
0015 Welcome to the manual for `digiKam <https://www.digikam.org>`_, the free and open source photo management program.
0016 
0017 The current digiKam version you get `here <https://www.digikam.org/download/>`_.
0018 
0019 You can download this manual as an `EPUB <https://docs.digikam.org/en/epub/DigikamManual.epub>`_.
0020 
0021 ###############
0022 Getting Started
0023 ###############
0024 .. figure:: images/index_getting_started.webp
0025     :width: 300px
0026     :alt:
0027     :target: getting_started.html
0028 
0029     Do Your First Steps in digiKam Photo Management Program
0030 
0031 .. container:: toctile
0032 
0033     .. container:: tile no-descr
0034 
0035         :ref:`application_intro`
0036 
0037     .. container:: tile no-descr
0038 
0039         :ref:`application_install`
0040 
0041     .. container:: tile no-descr
0042 
0043         :ref:`quick_start`
0044 
0045     .. container:: tile no-descr
0046 
0047         :ref:`database_intro`
0048 
0049 .. toctree::
0050    :maxdepth: 2
0051    :hidden:
0052 
0053    getting_started
0054 
0055 ###################
0056 Supported Materials
0057 ###################
0058 .. figure:: images/index_supported_materials.webp
0059     :width: 300px
0060     :alt:
0061     :target: supported_materials.html
0062 
0063     File Formats and Devices Supported in digiKam
0064 
0065 .. container:: toctile
0066 
0067     .. container:: tile no-descr
0068 
0069         :ref:`image_formats`
0070 
0071     .. container:: tile no-descr
0072 
0073         :ref:`movie_formats`
0074 
0075     .. container:: tile no-descr
0076 
0077         :ref:`camera_devices`
0078 
0079 .. toctree::
0080    :maxdepth: 2
0081    :hidden:
0082 
0083    supported_materials
0084 
0085 ###########
0086 Main Window
0087 ###########
0088 .. figure:: images/index_main_window.webp
0089     :width: 300px
0090     :alt:
0091     :target: main_window.html
0092 
0093     Using the digiKam Main Window to Show Collection Contents
0094 
0095 .. container:: toctile
0096 
0097     .. container:: tile no-descr
0098 
0099         :ref:`interface_layout`
0100 
0101     .. container:: tile no-descr
0102 
0103         :ref:`image_view`
0104 
0105     .. container:: tile no-descr
0106 
0107         :ref:`albums_view`
0108 
0109     .. container:: tile no-descr
0110 
0111         :ref:`tags_view`
0112 
0113     .. container:: tile no-descr
0114 
0115         :ref:`search_view`
0116 
0117     .. container:: tile no-descr
0118 
0119         :ref:`similarity_view`
0120 
0121     .. container:: tile no-descr
0122 
0123         :ref:`mapsearch_view`
0124 
0125     .. container:: tile no-descr
0126 
0127         :ref:`people_view`
0128 
0129 .. toctree::
0130    :maxdepth: 2
0131    :hidden:
0132 
0133    main_window
0134 
0135 #############
0136 Right Sidebar
0137 #############
0138 .. figure:: images/index_right_sidebar.webp
0139     :width: 300px
0140     :alt:
0141     :target: right_sidebar.html
0142 
0143     Using the digiKam Right Sidebar to Play with Item Properties
0144 
0145 .. container:: toctile
0146 
0147     .. container:: tile no-descr
0148 
0149         :ref:`sidebar_overview`
0150 
0151     .. container:: tile no-descr
0152 
0153         :ref:`properties_view`
0154 
0155     .. container:: tile no-descr
0156 
0157         :ref:`metadata_view`
0158 
0159     .. container:: tile no-descr
0160 
0161         :ref:`colors_view`
0162 
0163     .. container:: tile no-descr
0164 
0165         :ref:`maps_view`
0166 
0167     .. container:: tile no-descr
0168 
0169         :ref:`captions_view`
0170 
0171     .. container:: tile no-descr
0172 
0173         :ref:`versions_view`
0174 
0175     .. container:: tile no-descr
0176 
0177         :ref:`filters_view`
0178 
0179     .. container:: tile no-descr
0180 
0181         :ref:`tools_view`
0182 
0183 .. toctree::
0184    :maxdepth: 2
0185    :hidden:
0186 
0187    right_sidebar
0188 
0189 ###########
0190 Light Table
0191 ###########
0192 .. figure:: images/index_light_table.webp
0193     :width: 300px
0194     :alt:
0195     :target: light_table.html
0196 
0197     Using the digiKam Light Table to Compare Items Side by Side
0198 
0199 .. container:: toctile
0200 
0201     .. container:: tile no-descr
0202 
0203         :ref:`lighttable_overview`
0204 
0205     .. container:: tile no-descr
0206 
0207         :ref:`lighttable_advanced`
0208 
0209 .. toctree::
0210    :maxdepth: 2
0211    :hidden:
0212 
0213    light_table
0214 
0215 ###################
0216 Batch Queue Manager
0217 ###################
0218 .. figure:: images/index_batch_queue.webp
0219     :width: 300px
0220     :alt:
0221     :target: batch_queue.html
0222 
0223     Using the digiKam Batch Queue Manager To Process Items in Parallel
0224 
0225 .. container:: toctile
0226 
0227     .. container:: tile no-descr
0228 
0229         :ref:`batchqueue_overview`
0230 
0231     .. container:: tile no-descr
0232 
0233         :ref:`queue_settings`
0234 
0235     .. container:: tile no-descr
0236 
0237         :ref:`bqm_workflow`
0238 
0239     .. container:: tile no-descr
0240 
0241         :ref:`base_tools`
0242 
0243     .. container:: tile no-descr
0244 
0245         :ref:`raw_converter`
0246 
0247     .. container:: tile no-descr
0248 
0249         :ref:`dng_converter`
0250 
0251     .. container:: tile no-descr
0252 
0253         :ref:`metadata_tools`
0254 
0255     .. container:: tile no-descr
0256 
0257         :ref:`custom_script`
0258 
0259     .. container:: tile no-descr
0260 
0261         :ref:`watermark_tool`
0262 
0263 .. toctree::
0264    :maxdepth: 2
0265    :hidden:
0266 
0267    batch_queue
0268 
0269 ############
0270 Import Tools
0271 ############
0272 .. figure:: images/index_import_tools.webp
0273     :width: 300px
0274     :alt:
0275     :target: import_tools.html
0276 
0277     How to Import New Items in Your Collections With digiKam
0278 
0279 .. container:: toctile
0280 
0281     .. container:: tile no-descr
0282 
0283         :ref:`import_overview`
0284 
0285     .. container:: tile no-descr
0286 
0287         :ref:`camera_import`
0288 
0289     .. container:: tile no-descr
0290 
0291         :ref:`advanced_import`
0292 
0293     .. container:: tile no-descr
0294 
0295         :ref:`scanner_import`
0296 
0297     .. container:: tile no-descr
0298 
0299         :ref:`remote_import`
0300 
0301     .. container:: tile no-descr
0302 
0303         :ref:`google_import`
0304 
0305     .. container:: tile no-descr
0306 
0307         :ref:`smugmug_import`
0308 
0309 .. toctree::
0310    :maxdepth: 2
0311    :hidden:
0312 
0313    import_tools
0314 
0315 ########################
0316 Digital Asset Management
0317 ########################
0318 .. figure:: images/index_asset_management.webp
0319     :width: 300px
0320     :alt:
0321     :target: asset_management.html
0322 
0323     Learn The Basis to Handle Safety Large Digital Photography Collections In Time
0324 
0325 .. container:: toctile
0326 
0327     .. container:: tile no-descr
0328 
0329         :ref:`dam_overview`
0330 
0331     .. container:: tile no-descr
0332 
0333         :ref:`organize_find`
0334 
0335     .. container:: tile no-descr
0336 
0337         :ref:`authorship_copyright`
0338 
0339     .. container:: tile no-descr
0340 
0341         :ref:`data_protection`
0342 
0343     .. container:: tile no-descr
0344 
0345         :ref:`dam_workflow`
0346 
0347 .. toctree::
0348    :maxdepth: 2
0349    :hidden:
0350 
0351    asset_management
0352 
0353 ################
0354 Color Management
0355 ################
0356 .. figure:: images/index_color_management.webp
0357     :width: 300px
0358     :alt:
0359     :target: color_management.html
0360 
0361     Learn The Fundamental Rules of Color Management
0362 
0363 .. container:: toctile
0364 
0365     .. container:: tile no-descr
0366 
0367         :ref:`basis_knowledge`
0368 
0369     .. container:: tile no-descr
0370 
0371         :ref:`working_space`
0372 
0373     .. container:: tile no-descr
0374 
0375         :ref:`monitor_profiles`
0376 
0377     .. container:: tile no-descr
0378 
0379         :ref:`camera_profiles`
0380 
0381     .. container:: tile no-descr
0382 
0383         :ref:`printer_profiles`
0384 
0385 .. toctree::
0386    :maxdepth: 2
0387    :hidden:
0388 
0389    color_management
0390 
0391 ############
0392 Image Editor
0393 ############
0394 .. figure:: images/index_image_editor.webp
0395     :width: 300px
0396     :alt:
0397     :target: image_editor.html
0398 
0399     Using digiKam to Edit and Improve Your Photographs
0400 
0401 .. container:: toctile
0402 
0403     .. container:: tile no-descr
0404 
0405         :ref:`editor_overview`
0406 
0407     .. container:: tile no-descr
0408 
0409         :ref:`basic_operations`
0410 
0411     .. container:: tile no-descr
0412 
0413         :ref:`workflow_tools`
0414 
0415     .. container:: tile no-descr
0416 
0417         :ref:`colors_tools`
0418 
0419     .. container:: tile no-descr
0420 
0421         :ref:`enhancement_tools`
0422 
0423     .. container:: tile no-descr
0424 
0425         :ref:`transform_tools`
0426 
0427     .. container:: tile no-descr
0428 
0429         :ref:`decorate_tools`
0430 
0431     .. container:: tile no-descr
0432 
0433         :ref:`effects_tools`
0434 
0435 .. toctree::
0436    :maxdepth: 2
0437    :hidden:
0438 
0439    image_editor
0440 
0441 #################
0442 Setup Application
0443 #################
0444 .. figure:: images/index_setup_application.webp
0445     :width: 300px
0446     :alt:
0447     :target: setup_application.html
0448 
0449     Using the digiKam Configuration Panel to Customize Application
0450 
0451 .. container:: toctile
0452 
0453     .. container:: tile no-descr
0454 
0455         :ref:`config_overview`
0456 
0457     .. container:: tile no-descr
0458 
0459         :ref:`database_settings`
0460 
0461     .. container:: tile no-descr
0462 
0463         :ref:`collections_settings`
0464 
0465     .. container:: tile no-descr
0466 
0467         :ref:`views_settings`
0468 
0469     .. container:: tile no-descr
0470 
0471         :ref:`tooltip_settings`
0472 
0473     .. container:: tile no-descr
0474 
0475         :ref:`metadata_settings`
0476 
0477     .. container:: tile no-descr
0478 
0479         :ref:`templates_settings`
0480 
0481     .. container:: tile no-descr
0482 
0483         :ref:`editor_settings`
0484 
0485     .. container:: tile no-descr
0486 
0487         :ref:`cm_settings`
0488 
0489     .. container:: tile no-descr
0490 
0491         :ref:`lighttable_settings`
0492 
0493     .. container:: tile no-descr
0494 
0495         :ref:`imgqsort_settings`
0496 
0497     .. container:: tile no-descr
0498 
0499         :ref:`camera_settings`
0500 
0501     .. container:: tile no-descr
0502 
0503         :ref:`plugins_settings`
0504 
0505     .. container:: tile no-descr
0506 
0507         :ref:`miscs_settings`
0508 
0509     .. container:: tile no-descr
0510 
0511         :ref:`theme_settings`
0512 
0513     .. container:: tile no-descr
0514 
0515         :ref:`languages_settings`
0516 
0517     .. container:: tile no-descr
0518 
0519         :ref:`toolbars_settings`
0520 
0521     .. container:: tile no-descr
0522 
0523         :ref:`notifications_settings`
0524 
0525     .. container:: tile no-descr
0526 
0527         :ref:`shortcuts_settings`
0528 
0529 .. toctree::
0530    :maxdepth: 2
0531    :hidden:
0532 
0533    setup_application
0534 
0535 ##################
0536 Geolocation Editor
0537 ##################
0538 .. figure:: images/index_geolocation_editor.webp
0539     :width: 300px
0540     :alt:
0541     :target: geolocation_editor.html
0542 
0543     Edit Geolocation Information to Search And Visualize Items on a Map
0544 
0545 .. container:: toctile
0546 
0547     .. container:: tile no-descr
0548 
0549         :ref:`geoeditor_overview`
0550 
0551     .. container:: tile no-descr
0552 
0553         :ref:`geoeditor_map`
0554 
0555     .. container:: tile no-descr
0556 
0557         :ref:`geoeditor_coordinates`
0558 
0559     .. container:: tile no-descr
0560 
0561         :ref:`geoeditor_reverse`
0562 
0563     .. container:: tile no-descr
0564 
0565         :ref:`geoeditor_search`
0566 
0567     .. container:: tile no-descr
0568 
0569         :ref:`geoeditor_kmlexport`
0570 
0571 .. toctree::
0572    :maxdepth: 2
0573    :hidden:
0574 
0575    geolocation_editor
0576 
0577 #################
0578 Maintenance Tools
0579 #################
0580 .. figure:: images/index_maintenance_tools.webp
0581     :width: 300px
0582     :alt:
0583     :target: maintenance_tools.html
0584 
0585     Maintaining and Optimize Data From Your Collections
0586 
0587 .. container:: toctile
0588 
0589     .. container:: tile no-descr
0590 
0591         :ref:`maintenance_overview`
0592 
0593     .. container:: tile no-descr
0594 
0595         :ref:`maintenance_common`
0596 
0597     .. container:: tile no-descr
0598 
0599         :ref:`maintenance_newitems`
0600 
0601     .. container:: tile no-descr
0602 
0603         :ref:`maintenance_database`
0604 
0605     .. container:: tile no-descr
0606 
0607         :ref:`maintenance_thumbnails`
0608 
0609     .. container:: tile no-descr
0610 
0611         :ref:`maintenance_fingerprints`
0612 
0613     .. container:: tile no-descr
0614 
0615         :ref:`maintenance_duplicates`
0616 
0617     .. container:: tile no-descr
0618 
0619         :ref:`maintenance_faces`
0620 
0621     .. container:: tile no-descr
0622 
0623         :ref:`maintenance_quality`
0624 
0625     .. container:: tile no-descr
0626 
0627         :ref:`maintenance_metadata`
0628 
0629 .. toctree::
0630    :maxdepth: 2
0631    :hidden:
0632 
0633    maintenance_tools
0634 
0635 ###############
0636 Post Processing
0637 ###############
0638 .. figure:: images/index_post_processing.webp
0639     :width: 300px
0640     :alt:
0641     :target: post_processing.html
0642 
0643     Post Process Items From Your Collections
0644 
0645 .. container:: toctile
0646 
0647     .. container:: tile no-descr
0648 
0649         :ref:`metadata_editor`
0650 
0651     .. container:: tile no-descr
0652 
0653         :ref:`html_gallery`
0654 
0655     .. container:: tile no-descr
0656 
0657         :ref:`media_server`
0658 
0659     .. container:: tile no-descr
0660 
0661         :ref:`send_images`
0662 
0663     .. container:: tile no-descr
0664 
0665         :ref:`print_creator`
0666 
0667     .. container:: tile no-descr
0668 
0669         :ref:`time_adjust`
0670 
0671     .. container:: tile no-descr
0672 
0673         :ref:`pano_creator`
0674 
0675     .. container:: tile no-descr
0676 
0677         :ref:`calendar_tool`
0678 
0679     .. container:: tile no-descr
0680 
0681         :ref:`mjpeg_stream`
0682 
0683     .. container:: tile no-descr
0684 
0685         :ref:`expo_blending`
0686 
0687     .. container:: tile no-descr
0688 
0689         :ref:`video_slideshow`
0690 
0691     .. container:: tile no-descr
0692 
0693         :ref:`wall_paper`
0694 
0695     .. container:: tile no-descr
0696 
0697         :ref:`ocrtext_converter`
0698 
0699     .. container:: tile no-descr
0700 
0701         :ref:`jalbum_export`
0702 
0703     .. container:: tile no-descr
0704 
0705         :ref:`mosaicwall_tool`
0706 
0707 .. toctree::
0708    :maxdepth: 2
0709    :hidden:
0710 
0711    post_processing
0712 
0713 ############
0714 Export Tools
0715 ############
0716 .. figure:: images/index_export_tools.webp
0717     :width: 300px
0718     :alt:
0719     :target: export_tools.html
0720 
0721     Export Items From Your Collections To External Media
0722 
0723 .. container:: toctile
0724 
0725     .. container:: tile no-descr
0726 
0727         :ref:`flickr_export`
0728 
0729     .. container:: tile no-descr
0730 
0731         :ref:`google_export`
0732 
0733     .. container:: tile no-descr
0734 
0735         :ref:`media_wiki`
0736 
0737     .. container:: tile no-descr
0738 
0739         :ref:`inaturalist_export`
0740 
0741     .. container:: tile no-descr
0742 
0743         :ref:`twitter_export`
0744 
0745     .. container:: tile no-descr
0746 
0747         :ref:`imgur_export`
0748 
0749     .. container:: tile no-descr
0750 
0751         :ref:`pinterest_export`
0752 
0753     .. container:: tile no-descr
0754 
0755         :ref:`dropbox_export`
0756 
0757     .. container:: tile no-descr
0758 
0759         :ref:`box_export`
0760 
0761     .. container:: tile no-descr
0762 
0763         :ref:`one_drive`
0764 
0765     .. container:: tile no-descr
0766 
0767         :ref:`smugmug_export`
0768 
0769     .. container:: tile no-descr
0770 
0771         :ref:`image_shack`
0772 
0773     .. container:: tile no-descr
0774 
0775         :ref:`piwigo_export`
0776 
0777     .. container:: tile no-descr
0778 
0779         :ref:`remote_export`
0780 
0781     .. container:: tile no-descr
0782 
0783         :ref:`local_export`
0784 
0785 .. toctree::
0786    :maxdepth: 2
0787    :hidden:
0788 
0789    export_tools
0790 
0791 ###############
0792 Slideshow Tools
0793 ###############
0794 .. figure:: images/index_slideshow_tools.webp
0795     :width: 300px
0796     :alt:
0797     :target: slideshow_tools.html
0798 
0799     How to Use Tools to Present Your Items
0800 
0801 .. container:: toctile
0802 
0803     .. container:: tile no-descr
0804 
0805         :ref:`slide_tool`
0806 
0807     .. container:: tile no-descr
0808 
0809         :ref:`presentation_tool`
0810 
0811     .. container:: tile no-descr
0812 
0813         :ref:`opengl_viewer`
0814 
0815 .. toctree::
0816    :maxdepth: 2
0817    :hidden:
0818 
0819    slideshow_tools
0820 
0821 ########
0822 Showfoto
0823 ########
0824 .. figure:: images/index_showfoto_editor.webp
0825     :width: 300px
0826     :alt:
0827     :target: showfoto_editor.html
0828 
0829     Showfoto is a Stand Alone Version of the digiKam Image Editor
0830 
0831 .. container:: toctile
0832 
0833     .. container:: tile no-descr
0834 
0835         :ref:`showfoto_overview`
0836 
0837     .. container:: tile no-descr
0838 
0839         :ref:`showfoto_leftsidebar`
0840 
0841     .. container:: tile no-descr
0842 
0843         :ref:`showfoto_setup`
0844 
0845     .. container:: tile no-descr
0846 
0847         :ref:`showfoto_tools`
0848 
0849 .. toctree::
0850    :maxdepth: 2
0851    :hidden:
0852 
0853    showfoto_editor
0854 
0855 #################
0856 Menu Descriptions
0857 #################
0858 .. figure:: images/index_menu_descriptions.webp
0859     :width: 300px
0860     :alt:
0861     :target: menu_descriptions.html
0862 
0863     Learn Details About All digiKam Menus
0864 
0865 .. container:: toctile
0866 
0867     .. container:: tile no-descr
0868 
0869         :ref:`menu_mainwindow`
0870 
0871     .. container:: tile no-descr
0872 
0873         :ref:`menu_imageeditor`
0874 
0875     .. container:: tile no-descr
0876 
0877         :ref:`menu_batchqueue`
0878 
0879     .. container:: tile no-descr
0880 
0881         :ref:`menu_lighttable`
0882 
0883     .. container:: tile no-descr
0884 
0885         :ref:`menu_importtool`
0886 
0887     .. container:: tile no-descr
0888 
0889         :ref:`menu_showfoto`
0890 
0891 .. toctree::
0892    :maxdepth: 2
0893    :hidden:
0894 
0895    menu_descriptions
0896 
0897 ###################
0898 Credits and License
0899 ###################
0900 .. figure:: images/index_credits_license.webp
0901     :width: 300px
0902     :alt:
0903     :target: credits_license.html
0904 
0905     Copyrights and Notices About This Document
0906 
0907 .. container:: toctile
0908 
0909     .. container:: tile no-descr
0910 
0911         :ref:`credits_license`
0912 
0913 .. toctree::
0914    :maxdepth: 2
0915    :hidden:
0916 
0917    credits_license
0918 
0919 ############
0920 Get Involved
0921 ############
0922 .. figure:: images/index_get_involved.webp
0923     :width: 300px
0924     :alt:
0925     :target: get_involved.html
0926 
0927     Contribute to digiKam project
0928 
0929 .. container:: toctile
0930 
0931     .. container:: tile no-descr
0932 
0933         :ref:`get_involved`
0934 
0935 .. toctree::
0936    :maxdepth: 2
0937    :hidden:
0938 
0939    get_involved